README.md

Sphinx Wagtail theme

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

• MIT license
• Contributors
• Repository
• Documentation
• Security
• Changelog
• Supports Python > 3.7

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

• Clone this repo locally
• Set up a Python virtual environment (e.g. venv)
• Show all available tasks via make
• Run make setup to install the dependencies
• Run make frontend to build the frontend assets
• Run make install-for-development to build the theme package and install it in editable mode
• Run make docs to build the theme docs, which also serve as the example docs to develop the theme
• Run make serve to serve the theme docs at http://localhost:8000

See the documentation for more development instructions.

Release process

Checklist:

• CONTRIBUTORS.md is updated
• CHANGELOG.md is updated
• Everything is committed, clean checkout
• ~/.pypirc has a username and password (token)
• Add a git tag and a Github release once completed

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