Skip to main content

OpenWISP documentation sphinx theme

Project description

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/

https://user-images.githubusercontent.com/56113566/221259494-d7f5ecb9-8ed2-4187-a3dc-8ae51ed1d324.png

Installation

This theme is distributed on PyPI as openwisp-sphinx-theme and can be installed with pip:

$ python3 -m pip install openwisp-sphinx-theme

To 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.html

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openwisp_sphinx_theme-1.0.2.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

openwisp_sphinx_theme-1.0.2-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file openwisp_sphinx_theme-1.0.2.tar.gz.

File metadata

  • Download URL: openwisp_sphinx_theme-1.0.2.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for openwisp_sphinx_theme-1.0.2.tar.gz
Algorithm Hash digest
SHA256 4daf96bc3e2fcc821827f8e5a403a94624be3be8cec0977214c7f95e9fd95d0c
MD5 ab123c7cb78a17b2389ccbc7d5102e9e
BLAKE2b-256 19be3a32b86ff0f0c51984d009d5c860f5e1120a43e725180a406944a5301a68

See more details on using hashes here.

File details

Details for the file openwisp_sphinx_theme-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for openwisp_sphinx_theme-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6ef75a4e8892682a2536b31d7af1dcc29538a52bf272d373cc13b279f606a9b7
MD5 36653d6a8419de179b2cf75c41b40e88
BLAKE2b-256 9d7f466063a51f69dde7a87d275ec8462cdb68ab5aa0ecc90a34ff4acbb3b282

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page