Skip to main content

Sphinx Wagtail theme

Project description

Sphinx Wagtail theme

CI status PyPI version License: MIT

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 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


Getting started

Release process


  • is updated
  • 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
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/*


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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_wagtail_theme-6.3.0.tar.gz (2.0 MB view hashes)

Uploaded Source

Built Distribution

sphinx_wagtail_theme-6.3.0-py2.py3-none-any.whl (2.0 MB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page