A Sphinx theme for Nextstrain's documentation, based on Read The Docs' default theme (sphinx_rtd_theme).
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.
- 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 inlib/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
. - Generate the source and binary distributions with setup.py.
- Upload the two files from step 6 to PyPI with twine.