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 = "nextstrain-sphinx-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-2021.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d5f7a31b3da75bad143f26257a140c77d2c2641dcf223b2c5053bda8c6d39ea |
|
MD5 | b7fa769b4970d0c3786b3c6bf5ad4696 |
|
BLAKE2b-256 | 7861dea6381031496e821191a7a4f1ff2b7449a10cedffd03acbfee36521fd61 |
Hashes for nextstrain_sphinx_theme-2021.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6a021449f1ed3ffd9ae2cb437d1f6135a12b8a0d06c329451b81cfc071e1ce1 |
|
MD5 | 43fb179ca81d62a6d970de5d83a8c9ab |
|
BLAKE2b-256 | 2bd57f2ef917600ba1032428bd220e6611939cbce61ee1abfa224f28935648b3 |