Sphinx Wagtail theme contains all files required to build a Sphinx extension that provides the theme.
pip install sphinx-wagtail-theme
Select the "Sphinx Wagtail theme" in the conf.py
file of a Sphinx
# include the theme in the list of extensions to be loaded
extensions = ['sphinx_wagtail_theme', …]
# select the theme
html_theme = 'sphinx_wagtail_theme'
Checklist:
CONTRIBUTORS.md
is updatedCHANGELOG.md
is updatedsetup.cfg
is updated (see version
)~/.pypirc
has a username and password (token)X.Y.Z
vX.Y.Z
With an active virtual environment:
python -m pip install --upgrade -r requirements.txt
make clean
make clean-frontend
npm ci
npm run build
prerelease
git tag -a N.N.N -m "N.N.N"
git push origin N.N.N
python -m build
python -m twine upload --repository pypi dist/*
postrelease
Sphinx Wagtail theme is based on Sphinx Typo3 theme which is based on t3SphinxThemeRtd which is based on the Read the Docs Sphinx theme.