sphinx-benjcunningham-theme

Custom Sphinx theme based on the ubiquitous Read the Docs theme. It overrides the Read the Docs theme with custom components and styles.

Installation

Install the theme by adding the following to your library’s setup.py:

from setuptools import setup


extras = {
    ...
    "docs": [
        "sphinx_benjcunningham_theme @ https://github.com/benjcunningham/sphinx-benjcunningham-theme",
    ],
}

setup(
    ...
    extras_require=extras,
)

In your Sphinx conf.py, make sure to include the following:

extensions = [
    ...
    "sphinx_benjcunningham_theme",
]

html_theme = "sphinx_benjcunningham_theme"

Either build the documentation from your current branch using a tradition Sphinx build script, or build a versioned site using the following:

sphinx-multiversion docs/source docs/build