scanpydoc.theme

scanpydoc.theme#

A widescreen extension for Sphinx Book 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_book_theme’s Reference of theme options, e.g.:

html_theme_options = dict(
    repository_url="https://github.com/theislab/scanpydoc",
    repository_branch="main",
    use_repository_button=True,
)

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)[source]#

Set up theme (like an extension).

Parameters:
app Sphinx

Sphinx app to set this extension up for

Return type:

dict[str, bool]

Returns:

Metadata for this extension.