Skip to content

Commit c1e3375

Browse files
authored
Switch to Furo theme and use custom step (#33)
The "published" step uses an ages old version of Sphinx (2.2.4). This should also fix issues with links to referenced functions.
1 parent 435b6b3 commit c1e3375

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

.github/workflows/docs.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ jobs:
77
runs-on: ubuntu-latest
88
steps:
99
- uses: actions/checkout@v1
10-
- uses: ammaraskar/sphinx-action@master
11-
with:
12-
docs-folder: doc/
10+
- name: Build Sphinx documentation
11+
run: |
12+
pip install -r doc/requirements.txt
13+
sphinx-build doc/ ./doc/_build/html/
14+
1315
- name: Upload artifact
1416
# Automatically uploads an artifact from the './_site' directory by default
1517
uses: actions/upload-pages-artifact@v1

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
# The theme to use for HTML and HTML Help pages. See the documentation for
4646
# a list of builtin themes.
4747
#
48-
html_theme = "sphinx_rtd_theme"
48+
html_theme = "furo"
4949

5050
# Add any paths that contain custom static files (such as style sheets) here,
5151
# relative to this directory. They are copied after the builtin static files,

doc/requirements.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
sphinx_rtd_theme
1+
sphinx
2+
3+
# Theme, force pygments update
4+
furo>=2022.9.15
5+
pygments>=2.7

0 commit comments

Comments
 (0)