scverse-doc#
The shared Sphinx theme and documentation configuration for scverse packages.
Install it, and a package’s conf.py becomes:
extensions = ["scverse_doc"]
html_theme = "scverse"
html_theme_options = {"repo": "scverse/pertpy"}
That gets you the scverse brand and dark mode, the shared navbar, footer, and announcement banner, a “scverse packages” dropdown generated from the package registry, cross-links to every core package, and the standard extension stack.
Getting started#
Please refer to the documentation, in particular, the API documentation. The kitchen sink shows every construct the theme styles, in both colour schemes.
Installation#
You need to have Python 3.12 or newer installed on your system. If you don’t have Python installed, we recommend installing uv.
We recommend managing dependencies in project-specific virtual environments to avoid dependency conflicts. This is most convenient using package managers such as uv. Choose from the options below to install scverse-doc:
Install the latest development version:
pip install git+https://github.com/scverse/scverse-doc.git # (or `uv add`)
Release notes#
See the changelog.
Contact#
For questions and help requests, you can reach out in the scverse discourse. If you found a bug, please use the issue tracker.
Citation#
t.b.a