Build website automatically and publish to gh-pages

.github/workflows/pages.yml

@@ -0,0 +1,26 @@
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  docs:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+    - name: Set up Python
+      uses: actions/setup-python@v1
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        pip install -r doc/requirements.txt
+    - name: Build sphinx documentation
+      run: |
+        make -C doc html
+    - name: Deploy to gh-pages
+      uses: JamesIves/[email protected]
+      with:
+        branch: gh-pages # The branch the action should deploy to.
+        folder: doc/_build/html # The folder the action should deploy.

doc/.nojekyll

@@ -0,0 +1 @@
+This is published to GitHub Pages. It will ignore the _images path etc. otherwise.

doc/conf.py

@@ -52,4 +52,8 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_extra_path = ['.nojekyll']
+
 master_doc = 'index'
+
+online_wavedrom_js_url = "https://wavedrom.com"

doc/requirements.txt

@@ -1 +1 @@
-sphinxcontrib-wavedrom
+git+https://github.com/bavovanachte/sphinx-wavedrom@master#egg=sphinxcontrib-wavedrom