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.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 setupto install the dependencies - Run
make frontendto build the frontend assets - Run
make install-for-devto build the theme package and install it in editable mode - Run
make docsto build the theme docs, which also serve as the example docs to develop the theme - Run
make serveto 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.
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-5.1.0.tar.gz.
File metadata
- Download URL: sphinx_wagtail_theme-5.1.0.tar.gz
- Upload date:
- Size: 2.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e297273c3617001237538f124d9c682ed94d9e1121b1bcb7167ef81a3eecb2bd |
|
| MD5 | f948b9324d4f19a711f12c0d3df066dc |
|
| BLAKE2b-256 | abdae3b5cdc53f43ce3c420342a9329dd2902e72ee7bf95ada418052d586252a |
Provenance
File details
Details for the file sphinx_wagtail_theme-5.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_wagtail_theme-5.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 2.4 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a638fb18ae03f236f4e19df5adb1e703f0f017463a0e3fa1620baa997f547768 |
|
| MD5 | 5ad0b8b049f2e7bec710454c6237a008 |
|
| BLAKE2b-256 | df6b1f77c6b9de3ed4c084a39d28c2cafaf2df5030ca8533992085cb2897ebd1 |
