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.rst 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 tag to GitHub, e.g. git push origin main 2020.4.
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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9949128df0d4accd968b74a3c843c3c5dfbaa384ea607bfc5f95f8e4af6f4da6 |
|
MD5 | 53119b2f72dae9e1edca35cbebd8628e |
|
BLAKE2b-256 | 01765b65adfb7eae3f67fd3cb9691c62859db6705bb425da7ea0ddbd928f423a |
Hashes for nextstrain_sphinx_theme-2021.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5a3dcf4ff03678d42e0f9450a5e5531abab3b7abd08a69d55713a72ae2b78dc |
|
MD5 | f63874ab117a4769a4e950a04650ff8e |
|
BLAKE2b-256 | 2a04d14fd713936a93c8aa7e4cdf484c5ba12d36669837eede751aa90c35a4ea |