API

Configuration

config.apply_defaults(config)

Fill in the values conf.py did not set, and return the names that were applied.

Registry

registry.packages	Every registered package, keyed and ordered by case-folded name.
registry.core_packages()	Return only the core packages.
registry.intersphinx(*extra[, external, core])	Build an intersphinx_mapping for this package.

class scverse_doc.registry.Package(name: str, kind: Literal['core', 'ecosystem'], docs: str, inventory: str | None = None, repo: str | None = None, description: str = '', accent: str = '#4557c4')

One entry in the scverse package registry.

accent: str

The package’s brand accent, falling back to the scverse primary.

description: str

One-line summary, as recorded upstream.

docs: str

Where to send a reader, exactly as the upstream listing records it.

This is a link for humans, so it may name a particular page rather than a documentation root.

inventory: str | None

Root URL under which the package’s objects.inv resolves, or None if it publishes no inventory.

Distinct from docs: a versioned Read the Docs site serves its inventory and pages under en/stable/ or the like, while its documentation home is the bare domain.

kind: Literal['core', 'ecosystem']

Whether the package is maintained by the core team or listed as an ecosystem package.

name: str

The package’s display name, e.g. "scvi-tools".

repo: str | None

URL of the source repository, if the upstream listing records one.