Skip to content

Commit

Permalink
Switch to Furo theme and use custom step
Browse files Browse the repository at this point in the history
The "published" step uses an ages old version of Sphinx (2.2.4). This
should also fix issues with links to referenced functions.
  • Loading branch information
filmor committed Sep 17, 2022
1 parent 435b6b3 commit 29ab924
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
8 changes: 5 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: doc/
- name: Build Sphinx documentation
run: |
pip install -r doc/requirements.txt
sphinx-build doc/ ./doc/_build/html/
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v1
Expand Down
6 changes: 5 additions & 1 deletion doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
sphinx_rtd_theme
sphinx

# Theme, force pygments update
furo>=2022.9.15
pygments>=2.7

0 comments on commit 29ab924

Please sign in to comment.