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-2020.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cbc6f0eb1642f15da646c29e8a18a558b02227c520d1e043265e84916636daf |
|
MD5 | 5556ba036ef8089c994375c696e45dc3 |
|
BLAKE2b-256 | ac5042273241152ef799e4d918ad1291e7e8989bd0e3233c976e7475fe037093 |
Hashes for nextstrain_sphinx_theme-2020.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27947c09cdfa2c7f5f9ac680082220571e720705a4712c9e6f78420be0445e6c |
|
MD5 | c183d8bfde4945500dab3d9f6959556c |
|
BLAKE2b-256 | 1c091cb31a7e5bd8ab1510e97b9d1876981a74bcb1df1a3b0bc3c61bf191be80 |