From 248d4aef2f5521898d483928afc6e962cc358c81 Mon Sep 17 00:00:00 2001 From: Benedikt Reinartz Date: Sat, 17 Sep 2022 15:50:38 +0200 Subject: [PATCH] Switch to Furo theme and use custom step The "published" step uses an ages old version of Sphinx (2.2.4). This should also fix issues with links to referenced functions. --- .github/workflows/docs.yml | 8 +++++--- doc/conf.py | 2 +- doc/requirements.txt | 6 +++++- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ed89bc2..bce19d4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -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 diff --git a/doc/conf.py b/doc/conf.py index 5f97ad9..dac323a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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, diff --git a/doc/requirements.txt b/doc/requirements.txt index 483a4e9..97147a4 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1 +1,5 @@ -sphinx_rtd_theme +sphinx + +# Theme, force pygments update +furo>=2022.9.15 +pygments>=2.7