Sphinx Wagtail theme

Sphinx Wagtail theme contains all files required to build a Sphinx extension that provides the theme.

Installation

pip install sphinx-wagtail-theme

Usage

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'

See the documentation for more usage instructions

Development

Getting started

Instructions for Mac, Linux, and Windows

Release process

Checklist:

CONTRIBUTORS.md is updated
CHANGELOG.md is updated
setup.cfg is updated (see version)
Everything is committed, clean checkout
~/.pypirc has a username and password (token)
Add a git tag at the release commit with the format X.Y.Z
Create a GitHub release against that tag with the title format 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

Credits

Sphinx Wagtail theme is based on Sphinx Typo3 theme which is based on t3SphinxThemeRtd which is based on the Read the Docs Sphinx theme.

Thank you to Vercel for hosting the theme’s preview sites.