Nextstrain theme for Sphinx and Read The Docs
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"
Boolean determining if the Nextstrain logo should be displayed. Defaults to true.
URL to use for the logo’s link. Defaults to <https://docs.nextstrain.org>.
Ignored. Inherited from sphinx_rtd_theme. Instead, the project name and version info will not be displayed (thus showing only the logo) when subproject is true.
Boolean determining if this is a subproject of the main Nextstrain documentation project on <https://docs.nextstrain.org>. 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.
python3 -m pip install -e . make clean # not always needed, but better to be cautious make html open build/html/index.html
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.
Publish to PyPI by invoking a GitHub Actions workflow:
PR test builds are available here: https://readthedocs.org/projects/nextstrain-sphinx-theme/builds/ and usually follow the following URL path convention: https://nextstrain–17.org.readthedocs.build/projects/sphinx-theme/en/17/ where 17 is the PR number
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for nextstrain-sphinx-theme-2023.2.tar.gz
Hashes for nextstrain_sphinx_theme-2023.2-py3-none-any.whl