Merge pull request #8 from lucyleeow/IS/7

WIP Add github action for building doc
sphinx-gallery · Mar 5, 2020 · 6b8af11 · 6b8af11
2 parents 7d3b2bc + 92b8382
commit 6b8af11
Show file tree

Hide file tree

Showing 11 changed files with 30 additions and 5 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -10,10 +10,9 @@ jobs:
           command: |
             python3 -m venv doc-env
             . doc-env/bin/activate
-            pip install -r requirements.txt --progress-bar off
-            pip install sphinx sphinx-gallery sphinx_rtd_theme pandas matplotlib --progress-bar off
+            pip install -r requirements_doc.txt --progress-bar off
             pip install .
-            cd doc
+            cd docs
             make html
       - store_artifacts:
           path: doc/_build/html

diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml
@@ -0,0 +1,22 @@
+name: "Build documentation"
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    # Standard drop-in approach that should work for most people.
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+        pre-build-command: "pip install -r requirements_doc.txt && pip install ."
+    # Great extra actions to compose with:
+    # Create an artifact of the html output.
+    - uses: actions/upload-artifact@v1
+      with:
+        name: DocumentationHTML
+        path: docs/_build/html/
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/class.rst → docs/class.rst b/doc/class.rst → docs/class.rst
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'sample-project'
-copyright = '2019, <Author>'
+copyright = '2020, <Author>'
 author = '<Author>'
 
 # The full version, including alpha/beta/rc tags

diff --git a/doc/function.rst → docs/function.rst b/doc/function.rst → docs/function.rst
diff --git a/doc/getting_started.rst → docs/getting_started.rst b/doc/getting_started.rst → docs/getting_started.rst
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
diff --git a/requirements.txt b/requirements.txt
diff --git a/requirements_doc.txt b/requirements_doc.txt
@@ -0,0 +1,5 @@
+sphinx
+sphinx-gallery
+sphinx_rtd_theme
+matplotlib
+pandas