docs: add github workflow for build and pushing docs

.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+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: Start Slurm Container
+        uses: sudo-bot/action-docker-compose@latest
+        with:
+          cli-args: "-f docker-compose-github.yml up -d"
+        env:
+          PYTHON: "3.9"
+
+      - name: Build PySlurm
+        run: |
+          docker exec slurmctl python3.9 -m pip install Cython
+          docker exec slurmctl python3.9 setup.py build
+          docker exec slurmctl python3.9 setup.py install
+
+      - name: Install Sphinx
+        run: |
+
+      - name: Build Docs
+        run: |
+          docker exec slurmctl python3.9 -m pip install sphinx pydata_sphinx_theme
+          docker exec slurmctl make -C docs html
+
+#      - name: Build Docs and Commit
+#        uses: sphinx-notes/pages@master
+#        with:
+#          documentation_path: docs/source
+
+#      - name: Push changes
+#        uses: ad-m/github-push-action@master
+#        with:
+#          github_token: ${{ secrets.GITHUB_TOKEN }}
+#          branch: gh-pages

.github/workflows/pyslurm.yml

@@ -14,23 +14,27 @@ jobs:
     steps:
       - name: Checkout repository code
         uses: actions/checkout@v2
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install Dependencies
         run: |
           which python
           which python${{ matrix.python-version }}
           python${{ matrix.python-version }} -m pip install --upgrade pip
           python${{ matrix.python-verison }} -m pip install pipenv
           pipenv --python ${{matrix.python-version }} install --dev --skip-lock
+
       - name: Start Slurm Container
         uses: sudo-bot/action-docker-compose@latest
         with:
           cli-args: "-f docker-compose-github.yml up -d"
         env:
           PYTHON: ${{ matrix.python-version }}
+
       - name: Debug
         run: |
           docker ps -a
@@ -39,6 +43,7 @@ jobs:
           ls -al
           docker inspect slurmctl
           env | sort
+
       - name: Build/Install/Test PySlurm
         run: |
           pipenv run pytest -sv scripts/run_tests_in_container.py

.gitignore

@@ -2,7 +2,7 @@
 build/
 
 # Ignore Docs Directory #
-#doc/
+#docs/
 
 # Ignore Temporary Build Files #
 pyslurm/pyslurm.c

Pipfile

@@ -5,6 +5,8 @@ name = "pypi"
 
 [packages]
 cython = "*"
+sphinx = "*"
+pydata-sphinx-theme = "*"
 
 [dev-packages]
 black = "*"