A Sphinx theme for OpenWISP docs, based on the Read The Docs default theme (sphinx_rtd_theme).
Live demo: https://openwisp-sphinx-theme.readthedocs.io/en/latest/
Installation
This theme is distributed on PyPI as openwisp-sphinx-theme and can be installed with pip:
$ python3 -m pip install openwisp-sphinx-themeTo use the theme in your Sphinx project, you will need to add the following to your conf.py file:
# add this extension
extensions = [...,
'openwisp.sphinx.theme',
...
]
html_theme = "openwisp-sphinx-theme"Development
python3 -m pip install -e .
make clean # Not always needed, but better to be cautious
make html
open build/html/index.htmlNeed help?
If any help regarding installing and using sphinx and reStructured Text is required then please visit this link.
Feel free to post any doubt or comment through our support channels.
2 maintainers
Release files for openwisp-sphinx-theme 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openwisp_sphinx_theme-1.0.2.tar.gz | 9.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openwisp_sphinx_theme-1.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 19.2 kB
Release files / openwisp_sphinx_theme-1.0.2.tar.gz
| Download URL | openwisp_sphinx_theme-1.0.2.tar.gz |
|---|---|
| Size | 9.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4daf96bc3e2fcc821827f8e5a403a94624be3be8cec0977214c7f95e9fd95d0c
|
|
BLAKE2b-256 checksum How to use checksums |
19be3a32b86ff0f0c51984d009d5c860f5e1120a43e725180a406944a5301a68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.14
|
Release files / openwisp_sphinx_theme-1.0.2-py3-none-any.whl
| Download URL | openwisp_sphinx_theme-1.0.2-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6ef75a4e8892682a2536b31d7af1dcc29538a52bf272d373cc13b279f606a9b7
|
|
BLAKE2b-256 checksum How to use checksums |
9d7f466063a51f69dde7a87d275ec8462cdb68ab5aa0ecc90a34ff4acbb3b282
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.14
|
