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

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

This section is for maintainer reference.

1. Check all relevant changes since the last release are documented in CHANGELOG.md
2. Check if there are any new contributors and add them to CONTRIBUTORS.md
3. Update the version number in setup.cfg. The version number should follow Semantic Versioning.
4. Commit and push the changes
5. Create and push a new tag with the version number, prefixed with v. For example, v1.2.3
6. In the GitHub repository, create a new release against the tag you just pushed.
7. Once the release is created, the CI will automatically publish the new version to PyPI.

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.