Sphinx Wagtail theme
Project description
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
Release process
This section is for maintainer reference.
- Check all relevant changes since the last release are documented in
CHANGELOG.md
- Check if there are any new contributors and add them to
CONTRIBUTORS.md
- Update the version number in
setup.cfg
. The version number should follow Semantic Versioning. - Commit and push the changes
- Create and push a new tag with the version number, prefixed with
v
. For example,v1.2.3
- In the GitHub repository, create a new release against the tag you just pushed.
- 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinx_wagtail_theme-6.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1230607a271f99d99c28c1997a67614b8eca492d2340c4fa877f241fb5b2ac7d |
|
MD5 | 5f16e4d907a3e5ca1ee3c417d6f9f6e7 |
|
BLAKE2b-256 | 55913da392d7bd3167fed87b1ec569bc9ed6d392474b61a86f7ec110a35c8e0e |
Close
Hashes for sphinx_wagtail_theme-6.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bd44d502888db9e9bd04b09465e0f186ce04a87f1ebc44e3e648574109c1e04 |
|
MD5 | 642ec83caf8b732f21305e3a7d66a15f |
|
BLAKE2b-256 | ae2693c8605d56445717a47b1c6e7bb2227af27d7aac5bada1d6efe26dae17e2 |