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
Checklist:
-
CONTRIBUTORS.mdis updated -
CHANGELOG.mdis updated -
setup.cfgis updated (seeversion) - Everything is committed, clean checkout
-
~/.pypirchas 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
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.
Thank you to Vercel for hosting the theme’s preview sites.
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
File details
Details for the file sphinx_wagtail_theme-6.3.0.tar.gz.
File metadata
- Download URL: sphinx_wagtail_theme-6.3.0.tar.gz
- Upload date:
- Size: 2.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5038219fa32a78f0da35425c5fa058db4fd87336682318a6b9684495887bccfb |
|
| MD5 | 2c329799a004809927322255d4c96490 |
|
| BLAKE2b-256 | 82b805675758b93f56717636a54df437e60ef2ca4d31995cb7d7255e0e75b097 |
Provenance
File details
Details for the file sphinx_wagtail_theme-6.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_wagtail_theme-6.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 2.0 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 53aa8e4bf69cf64d2549448a98b01bd90ccefa5b906fec9f82c3987506c2687f |
|
| MD5 | 2f08be23f85c8939b6394eb0aad20602 |
|
| BLAKE2b-256 | 9042b2a7aca96e8eb87ec0882bbbd306071d089e798bea42d715cd232e567b44 |
