scverse_doc.theme#

The theme: brand chrome, the per-package accent, and the ecosystem dropdown.

Registers html_theme = "scverse" and translates the options a package declares (package, repo, accent) into what pydata-sphinx-theme expects.

Theme options#

html_theme_options keys this theme adds. Everything else there is pydata-sphinx-theme’s.

package#
Type:
str
Default:
project

The registry name to look the accent and the dropdown’s current entry up under.

repo#
Type:
str
Default:
""

owner/name on GitHub. Adds the navbar icon and the “edit this page” button.

branch#
Type:
str
Default:
$READTHEDOCS_GIT_IDENTIFIER, else "main"

The ref repo’s edit links point at. Read the Docs pull request builds fall back to the default, since they identify by PR number.

doc_path#
Type:
str
Default:
"docs/"

Where the documentation sources live in repo.

accent#
Type:
str
Default:
the registry accent, else the scverse primary

CSS colour for decorative surfaces; link and text shades are derived from it.

show_ecosystem_dropdown#
Type:
bool
Default:
True

Whether the navbar carries the “scverse packages” dropdown.