Skip to content

Commit 46f1bbc

Browse files
committed
Switch from the private pallets theme to furo for documentation.
1 parent 118019a commit 46f1bbc

File tree

4 files changed

+14
-3
lines changed

4 files changed

+14
-3
lines changed

.github/workflows/release.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@ jobs:
2323
- name: Install Poetry
2424
uses: snok/install-poetry@v1
2525

26+
- name: Installing
27+
run: poetry install --no-interaction
28+
29+
- name: Building documentation
30+
run: |
31+
cd docs && make clean && make html
32+
33+
- name: Publishing documentation
34+
run: |
35+
ghp-import -f -n docs/_build/html
36+
2637
- name: Publishing
2738
env:
2839
PYPI_TOKEN: ${{ secrets.PYPI_PASSWORD }}

docs/_static/.keep

Whitespace-only changes.

docs/conf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@
3232
# ones.
3333
extensions = [
3434
'sphinx.ext.autodoc',
35-
'sphinx.ext.viewcode',
36-
'pallets_sphinx_themes'
35+
'sphinx.ext.viewcode'
3736
]
3837

3938
# Add any paths that contain templates here, relative to this directory.
@@ -50,7 +49,7 @@
5049
# The theme to use for HTML and HTML Help pages. See the documentation for
5150
# a list of builtin themes.
5251
#
53-
html_theme = 'flask'
52+
html_theme = 'furo'
5453

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

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ ghp-import = "^2.1.0"
4343
Sphinx = "^5.3.0"
4444
coverage = "^6.4.4"
4545
pytest-cov = "^3.0.0"
46+
furo = "^2022.12.7"
4647

4748
[build-system]
4849
requires = ["poetry-core>=1.0.0"]

0 commit comments

Comments
 (0)