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.
Releasing
Make sure you have a PyPI account and access to https://pypi.org/project/nextstrain-sphinx-theme/.
Make sure all your changes have been commited to the main branch.
Add a commit which describes the changes from the previous version to CHANGES.md and updates the version number in lib/nextstrain/sphinx/theme/VERSION.
Tag this commit with the version number, e.g. git tag -a 2020.4 -m "version 2020.4".
Push the commit and the tag to the main branch.
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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 359182243bd1b8fc4bc874391cf89e41e4b6d2f88ded07c9ba842cc456a8ae4b |
|
MD5 | b839b7cf0e4a1b2bf6e2213c1478eb92 |
|
BLAKE2b-256 | 4f0c9cff6b124a66893e54f24f839c237d10a06197f130aff5f323e85034cdf8 |
Hashes for nextstrain_sphinx_theme-2020.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1be65b28afd40b6ad5ade38111d52ab776a85a6ef4989fda7e6b637e21dfc822 |
|
MD5 | 4f597e35d431f4c8689a6b06cc1a493c |
|
BLAKE2b-256 | 573e22a7b950c1ef92279a3e13f25757521a9a1784a8604d2790c388b8fa340d |