Add documentation action

.github/workflows/documentation.yml

@@ -0,0 +1,47 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ 'master' ]
+  pull_request:
+
+  workflow_dispatch:
+
+# Compile the docs and deploy to GitHub pages
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks out the repository
+      - uses: actions/checkout@v3
+        with:
+          ref: 'master'
+
+      - name: Install pandoc
+        run: sudo apt-get install -y pandoc
+
+      # Upgrade pip
+      - name: Upgrade pip
+        run: |
+          # install pip=>20.1 to use "pip cache dir"
+          python3 -m pip install --upgrade pip
+      # Cache dependencies
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "::set-output name=dir::$(pip cache dir)"
+
+      # Install sphinx
+      - name: Install dependencies
+        run: python3 -m pip install -r ./docs/requirements.txt
+
+      # Make docs
+      - name: Build docs
+        run: cd docs && make html
+
+      # Deploy
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html/

docs/requirements.txt

@@ -0,0 +1,12 @@
+recommonmark
+sphinx-rtd-theme==1.0.0
+Sphinx==5.1.*
+nbsphinx==0.8.*
+sphinx-rtd-theme==1.0.*
+sphinx-argparse
+sphinxcontrib-applehelp==1.0.*
+sphinxcontrib-devhelp==1.0.*
+sphinxcontrib-htmlhelp==2.0.*
+sphinxcontrib-jsmath==1.0.*
+sphinxcontrib-qthelp==1.0.*
+sphinxcontrib-serializinghtml==1.1.*