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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae3377e89637d541c3ec2c8de94a7c17ec660bcda26c2c292c642986a6177551 |
|
MD5 | 759d1752c4538f77f7282715f4081845 |
|
BLAKE2b-256 | 0d84c1368629ebc22dd5ab3291137026da6c9e11a5b95605633280748464a6b4 |
Hashes for nextstrain_sphinx_theme-2020.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 844811d62683a44aaf1f7cb4c21ff30529d834701a92c6a24b3f4ee951b08edf |
|
MD5 | fe6a6ebed942af57a7a2acee00d79725 |
|
BLAKE2b-256 | eff4265bf2b169b19499812da16c227d5f2696fe376acd07a8cee7b33d63eced |