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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a0a1337127a66b1398cba455ee686cf0f36e0707a969f848a9de42e749416af |
|
MD5 | 0b72132df81f876b8e45798f39eb0804 |
|
BLAKE2b-256 | 3bac9d0d3b8f1820b0e04d925a6f0b2589c07104bfad278a326286fc8ade0924 |
Hashes for nextstrain_sphinx_theme-2021.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 348e6a8d1ab94ab1dd29ebbd8d29a80fa0bc4b22885afc001c0f6d1a465bc3e9 |
|
MD5 | 5e0dc45e8a57e36eac446e3325beff8b |
|
BLAKE2b-256 | 4d97cce0f6b40b0d27735d98fd049fa9f65ce57f80360fd2e22101506abc5992 |