scanpydoc.theme

A widescreen extension for Read the Docs Sphinx Theme.

Add to conf.py:

html_theme = 'scanpydoc'

Theme options

This theme adds the following configuration option, and the ones under docsearch options:

accent_color
Type

str

Default

#f07e44

The CSS color used for the mobile header background and the project name text.

See sphinx_rtd_theme’s Configuration, e.g.:

html_theme_options = dict(
    logo_only=False,
    accent_color='rebeccapurple',
    display_version=False,
)

Docsearch options

These two configuration values are required to use docsearch:

docsearch_key
Type

str

The API key provided by docsearch.

docsearch_index
Type

str

The index name used by docsearch.

The following configuration values are optional:

docsearch_doc_version
Type

str

Default

'latest' or 'stable'

The documentation version searched. The default is 'stable' if READTHEDOCS_VERSION=stable is set, and 'latest' otherwise.

docsearch_js_version
Type

str

Default

'2.6'

The docsearch library version used.

Functions

setup(app)

Setup theme (like an extension)

Parameters
app : Sphinx

Sphinx app to set this extension up for

Returns

Metadata for this extension.