Sphinx Wagtail theme

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

• Free software: MIT license
• Authors: See AUTHORS.rst
• Repository: https://github.com/wagtail/sphinx_wagtail_theme
• Documentation: See docs/ folder

Release process

Checklist:

• AUTHORS.rst is updated
• HISTORY.rst (change log) is updated
• Everything is committed, clean checkout
• ~/.pypirc has a username and password (token)

With an active virtual environment:

python -m pip install --upgrade -r requirements.txt
make clean
make clean-frontend
npm install
npm run build
prerelease
git tag -a N.N.N -m "N.N.N"                                                                                       ✘ PIPE  sphinx_wagtail_theme  14.16.0 23:21:46
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.