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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 071b3a644c456ec2e51aab67a2607ee1fde0d8d60785e8ea7f9cc4f9d8be71a8 |
|
MD5 | a8620aa8c293e6cb6614fb8a4803722a |
|
BLAKE2b-256 | 6964ed72424365b6e2a6d1400c8fd8a2181c24a533b0ec9a1766b3b2ede61a04 |
Hashes for nextstrain_sphinx_theme-2020.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f6173d569ac66d4958d152e238b67c76df10fd6c754cdb074b64f2fa4a0a619 |
|
MD5 | b2484a1c6bb75e7c9fb7bcbdd18bbd8f |
|
BLAKE2b-256 | 43ac621ab0b55c60e598a488280aac7467a410a23cf76bc47125f2280fa1129a |