Kitchen sink#

Every component the theme styles, on one page, so a change to scverse.css can be eyeballed in both colour schemes. The navbar, ecosystem dropdown and footer are on this page like on any other – switch the theme with the toggle in the navbar.

Text#

Body copy with bold, italic, inline literal (the default role), an external link, an internal one, a footnote[1] and a cross-reference to intersphinx().

Third level#

Fourth level#

Inline maths \(e^{i\pi} = -1\) and a block:

\[ \operatorname{AA}(c_\text{fg}, c_\text{bg}) \geq 4.5 \]

Inline roles#

Press Ctrl + K, hit Search, then View ‣ Theme ‣ Dark. Run hatch run docs:build, which writes docs/_build/html/page.html, prints build succeeded, and is what CI calls. A token is a custom property; H2O and x2 also render.

Lists#

  • Bullet

  • Bullet

    • Nested

  1. Numbered

  2. Numbered

Definition list

Enabled through the deflist MyST extension.

Field and option lists and hlist are docutils-only, so they need eval-rst:

Field:

A field list entry.

Another:

A second one.

-W

Turn warnings into errors.

-D <setting=value>

Override a conf.py value.

--keep-going

A long option.

  • anndata

  • mudata

  • scanpy

  • scirpy

  • scvi-tools

  • squidpy

Admonitions#

Note

A note, in the theme’s border and surface tokens.

Warning

A warning.

See also

A cross-reference box.

Tip

A tip.

Important

Something important.

Hint

A hint.

Attention

Pay attention.

Caution

Be careful.

Danger

Danger.

Error

An error.

A custom title

An admonition with its own title, styled from the note class.

A collapsed dropdown

Body of the dropdown.

Versions#

Added in version 0.1.0: This page.

Changed in version 0.2.0: Grew the badge section.

Deprecated since version 0.3.0: Nothing yet.

Structure#

A rubric

A block quote, for text lifted from somewhere else.

A line block,
kept as broken.
token#

A CSS custom property in _tokens.css.

accent#

The per-package colour, decorative only.

Code#

With a caption and a copy button.#
from scverse_doc import intersphinx

mapping = intersphinx() | {"sphinx": ("https://www.sphinx-doc.org/en/master/", None)}

$ hatch run docs:build

1first = "plain"
2second = "emphasised"
3third = "plain"

>>> from scverse_doc import registry
>>> registry.packages["scanpy"].accent
'#de367b'

Table#

Token

Role

--scverse-color-accent-text

Links and text, contrast-checked

--scverse-color-accent-decorative

Underlines and surfaces

--scverse-radius

Shared component geometry

Cards#

Plain card

Title colour comes from --pst-heading-color.

Linked card

Hover it: the title switches to the accent, the card lifts.

api.md
With a footer

Body.

Footer.

Badges and buttons#

primary secondary info warning danger

primary is the scverse brand colour, secondary the package accent – so the two coincide whenever a package does not set accent and inherits the brand colour as its default. To see the accent-driven parts of the theme, build with one:

$ hatch run docs:build -D html_theme_options.accent=#de367b

A button

Tabs#

Content of the first tab.

Content of the second tab.