nextstrain-sphinx-theme 2020.4

Nextstrain theme for Sphinx and Read The Docs

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 = "sphinx_rtd_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.