📚 Automates the build of docs on GH pages

.github/workflows/docs2gh.yml

@@ -0,0 +1,34 @@
+name: Building documentation as gh-pages
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  build_docs:
+    name: documentation
+    runs-on: ubuntu-latest # ${{ matrix.platform }}
+
+    steps:
+      # Checkout the repository and setups the machine to use python
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+      - name: generates API documentation
+        # You may not run this step if done locally and the documentation was updated manually
+        # (and those files committed to the repository)
+        run: |
+          pip install sphinx
+          cd docs
+          sphinx-apidoc -o . ../sagittal_average
+      - name: Build and Commit
+        uses: sphinx-notes/pages@v2
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages

docs/conf.py

@@ -10,9 +10,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------
@@ -35,6 +35,7 @@
     'sphinx.ext.coverage', # Automatically check if functions are documented
     'sphinx.ext.mathjax',  # Allow support for algebra
     'sphinx.ext.viewcode', # Include the source code in documentation
+    'sphinx.ext.githubpages', # Publish HTML docs in GitHub Pages¶
 ]
 
 # Add any paths that contain templates here, relative to this directory.