docs: add github workflow for build and pushing docs

PySlurm · Nov 14, 2021 · 39d001b · 39d001b
1 parent ca4b08f
commit 39d001b
Show file tree

Hide file tree

Showing 12 changed files with 365 additions and 61 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,25 @@
+- name: Docs
+  on:
+    push:
+      branches:
+        - main
+        - sphinx
+  jobs:
+    build:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout
+          uses: actions/checkout@main
+          with:
+            fetch-depth: 0
+
+        - name: Build and Commit
+          uses: sphinx-notes/pages@master
+          with:
+            documentation_path: docs
+
+        - name: Push changes
+          uses: ad-m/github-push-action@master
+          with:
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            branch: gh-pages
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,7 @@
 build/
 
 # Ignore Docs Directory #
-#doc/
+#docs/
 
 # Ignore Temporary Build Files #
 pyslurm/pyslurm.c

diff --git a/Pipfile b/Pipfile
@@ -5,6 +5,8 @@ name = "pypi"
 
 [packages]
 cython = "*"
+sphinx = "*"
+pydata-sphinx-theme = "*"
 
 [dev-packages]
 black = "*"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -68,7 +68,7 @@ the documentation from the reStructuredText based docstrings found in the
 pyslurm module once it is built:
 
 ```shell
-cd doc
+cd docs
 make clean
 make html
 ```

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -9,6 +9,7 @@ services:
     tty: true
     working_dir: /pyslurm
     environment:
-      PYTHON: "3.9"
+      LANG: en_US.UTF-8
+      LC_ALL: en_US.UTF-8
     volumes:
       - ${PWD}:/pyslurm
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/doctrees/environment.pickle → docs/doctrees/environment.pickle b/doc/doctrees/environment.pickle → docs/doctrees/environment.pickle
diff --git a/doc/doctrees/index.doctree → docs/doctrees/index.doctree b/doc/doctrees/index.doctree → docs/doctrees/index.doctree
diff --git a/doc/source/_static/pyslurm-docs.png → docs/source/_static/pyslurm-docs.png b/doc/source/_static/pyslurm-docs.png → docs/source/_static/pyslurm-docs.png