Skip to content

Commit

Permalink
Switch to Furo theme and use custom step (#33)
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 authored Sep 17, 2022
1 parent 435b6b3 commit c1e3375
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 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
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
html_theme = "furo"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
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 c1e3375

Please sign in to comment.