sphinx.yml added (#33)

* sphinx.yml added

Co-authored-by: Martin Landa <[email protected]>

.github/workflows/sphinx.yml

@@ -0,0 +1,32 @@
+name: Pages
+on:
+  push:
+    branches:
+    - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+
+    - name: Install dependencies
+      run: |
+        sudo apt install --yes pandoc
+
+    - name: Build and Commit
+      uses: sphinx-notes/[email protected]
+      with:
+        documentation_path: ./docs
+        requirements_path: ./docs/requirements.txt
+
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: gh-pages

docs/conf.py

@@ -31,13 +31,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',  # Core Sphinx library for auto html doc generation from docstrings
-    'sphinx.ext.autosummary',  # Create neat summary tables for modules/classes/methods etc
-    'sphinx.ext.intersphinx',  # Link to other project's documentation (see mapping below)
-    'sphinx.ext.viewcode',  # Add a link to the Python source code for classes, functions etc.
     'nbsphinx',  # Integrate Jupyter Notebooks and Sphinx
-    'sphinx_copybutton',
-    'IPython.sphinxext.ipython_console_highlighting'
 ]
 
 autosummary_generate = True  # Turn on sphinx.ext.autosummary
@@ -80,4 +74,4 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'alabaster'

docs/requirements.txt

@@ -0,0 +1 @@
+nbsphinx==0.8.8