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 most of the same configuration options settable via html_theme_option and a few additional options as well:
- logo:
Boolean determining if the Nextstrain logo should be displayed. Defaults to true.
- logo_link:
URL to use for the logo’s link. Defaults to <https://docs.nextstrain.org>.
- logo_only:
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.
- subproject:
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.
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.
Publish to PyPI by invoking a GitHub Actions workflow:
Go to the workflow: publish.yml.
Select Run workflow. In the new menu:
Select Use workflow from > Tags > new version number (e.g. 2020.4).
Set PyPI instance for publishing as PyPI (default) or TestPyPI. More info
Select Run workflow.
Testing
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
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-2022.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 777c33470add2ee06ca282aafffdc1078e03f76f74ea4c43134ec7758ec35e98 |
|
MD5 | a7921c20d97ed9e0ceafa67c22fe73d3 |
|
BLAKE2b-256 | f7e13b16b47566ec502cc8fb6ebee10f0bc1a690127af1929b5fc11b6b3ae51f |
Hashes for nextstrain_sphinx_theme-2022.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06cff6e22d90c1289e5d55f0f5fda96bd15960dc410920b05ef06cb73a070e28 |
|
MD5 | 6bdad6e7565f904d32618a4dd70f4342 |
|
BLAKE2b-256 | 77fba7aaa493e48b3f942b54e5b4c40fcaee4e95d01d664ae37ae4100ef074e3 |