Make github action for sphinx docs (#26)

* make sphinx.yml workflow and edit for github actions * add .md support for source_suffix --------- Co-authored-by: jeffrey <[email protected]>
Marker-Inc-Korea · Jan 17, 2024 · 3ae4b68 · 3ae4b68
1 parent 361fe39
commit 3ae4b68
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 7 deletions.
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -0,0 +1,25 @@
+name: Sphinx build
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build HTML
+      uses: ammaraskar/[email protected]
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: html-docs
+        path: docs/build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html
diff --git a/dev_requirements.txt b/dev_requirements.txt
@@ -1,11 +1,5 @@
 pytest
 pytest-env
-sphinx
-furo
 twine
 build
 setuptools-scm
-myst-parser
-sphinx-inline-tabs
-sphinx-copybutton
-sphinx_design
diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,7 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+SPHINXBUILD   += sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,6 @@
+sphinx
+furo
+myst-parser
+sphinx-inline-tabs
+sphinx-copybutton
+sphinx_design
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -28,6 +28,10 @@
     "sphinx_design",
     "sphinx_inline_tabs",
 ]
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
 
 templates_path = ['_templates']
 exclude_patterns = []