diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..83c73af --- /dev/null +++ b/.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/github-pages-deploy-action@4.1.1 + with: + branch: gh-pages # The branch the action should deploy to. + folder: doc/_build/html # The folder the action should deploy. diff --git a/doc/.nojekyll b/doc/.nojekyll new file mode 100644 index 0000000..65cb711 --- /dev/null +++ b/doc/.nojekyll @@ -0,0 +1 @@ +This is published to GitHub Pages. It will ignore the _images path etc. otherwise. diff --git a/doc/conf.py b/doc/conf.py index 0d96a97..e2aa689 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -52,4 +52,8 @@ html_theme = 'alabaster' # 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" diff --git a/doc/requirements.txt b/doc/requirements.txt index 5443f82..5ed235f 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1 +1 @@ -sphinxcontrib-wavedrom +git+https://github.com/bavovanachte/sphinx-wavedrom@master#egg=sphinxcontrib-wavedrom