Merge pull request #290 from meekhumor/master

Add GitHub Action for Automated Sphinx Docs Update

Author: dpascualhe

.github/workflows/build-sphinx-docs.yml

@@ -0,0 +1,49 @@
+name: Build and Update Sphinx Docs
+
+
+on:
+ push:
+   branches:
+     - master
+ workflow_dispatch:
+
+
+jobs:
+ build-docs:
+   runs-on: ubuntu-latest
+
+
+   steps:
+     - name: Checkout repository
+       uses: actions/checkout@v4
+
+
+     - name: Set up Python
+       uses: actions/setup-python@v5
+       with:
+         python-version: '3.10'
+
+
+     - name: Install dependencies
+       run: |
+         python -m pip install --upgrade pip
+         pip install "sphinx>=8.1.3" "sphinx-rtd-theme>=3.0.2"
+         pip install -e . 
+
+
+     - name: Build Sphinx Docs
+       run: |
+         cd docs/py_docs
+         rm -rf _build/html/*  # Clean old files
+         sphinx-build -b html . _build/html
+
+
+     - name: Commit updated docs
+       run: |
+         git config --local user.email "[email protected]"
+         git config --local user.name "GitHub Action"
+         git add docs/py_docs/_build/html/*
+         git commit -m "Update Sphinx documentation in docs/py_docs/_build/html" || echo "No changes to commit"
+         git push
+       env:
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/py_docs/_build/html/modules.html

@@ -16,7 +16,6 @@
       <script src="_static/documentation_options.js?v=51b770b3"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
-      <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />

docs/py_docs/_build/html/searchindex.js

@@ -16,6 +16,7 @@
 
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
 ]
 
 templates_path = ["_templates"]