Nextstrain theme for Sphinx and Read The Docs
Project description
A Sphinx theme for Nextstrain’s documentation, based on Read The Docs’ default theme (sphinx_rtd_theme).
Installation
This theme is distributed on PyPI as nextstrain-sphinx-theme and can be installed with pip:
$ python3 -m pip install nextstrain-sphinx-theme
To use the theme in your Sphinx project, you will need to add the following to your conf.py file:
html_theme = "sphinx_rtd_theme"
This theme is based on sphinx_rtd_theme and accepts all of the same configuration options settable via html_theme_option. One additional option is supported:
- logo:
Boolean determining if the Nextstrain logo should be displayed. Defaults to true.
If your project wants to display its own logo, just set Sphinx’s html_logo to point to the image file in your Sphinx project.
html_logo = "_static/your-logo.png"
This will automatically take precedence over the default Nextstrain logo provided by the 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
Hashes for nextstrain-sphinx-theme-2020.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e21463ca69c9b68882441804df88dff3e588076b5f982ffcf5d8535460a42b9b |
|
MD5 | c90b856628bc14c664f1bf6c9157f02b |
|
BLAKE2b-256 | d2d4625899c2f272b6439272909d6a08792fbfde2c88883cb57611481ad9212e |
Hashes for nextstrain_sphinx_theme-2020.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 072e3d814a59397fd6f5da5b242234ce0cd8a38ea4f3fae5b9083dfef4944a8b |
|
MD5 | ad7dba2929e3b732827ee708461dfb65 |
|
BLAKE2b-256 | a02fde959543058727d1c7de077660f9ca5cb2ebf647a8215677d251ed56f27b |