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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ca0145cb6489751c1d5af9bba0f266496adb90e28fa7e52a4e7800863bfc35b |
|
MD5 | 10dc0ab3a9095ea21e420832ebe0833d |
|
BLAKE2b-256 | 10399df892c178ed988dbb468a28cf13eaf493193de41401de19cc19c1632e7e |
Hashes for nextstrain_sphinx_theme-2020.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e11159a944da7187006325ca455924a85daecd6af78baa80c4f23db9e3b36162 |
|
MD5 | 4964a4fb2859cc1c6a6a577f58d2bad0 |
|
BLAKE2b-256 | e9384adfcb4a32b1b3c45bb28e9aa00303140a19dd35a645873f0be5abe6e89a |