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.
Development
python3 -m pip install -e .
make clean # not always needed, but better to be cautious
make html
open build/html/index.html
Releasing
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-2023.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67f087037b8fe0c6813c4ec364d1544a9d5594be6e236bd59e380253b8256836 |
|
MD5 | ab0112e45e21c5d75ba990dfac7b20ac |
|
BLAKE2b-256 | 3ae4315cf88185e1795a9db734b17d8bfcf12a22a7eeeb66f3a90cca6022930c |
Hashes for nextstrain_sphinx_theme-2023.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df4e2412824898d9e9136c14d739ac765cc7e801e75c02411dd35a20ddbf8a38 |
|
MD5 | 55944eb2600d3f1c8e429a8a8c3f12a7 |
|
BLAKE2b-256 | aa7541544ee93f42cadd7ae4835c64201d976f0fc8f4b49a355592f020f84265 |