scverse-doc

The shared Sphinx theme and documentation configuration for scverse packages.

Install it, and a package's conf.py becomes:

extensions = ["scverse_doc"]

source_repository = "https://github.com/scverse/pertpy"

That gets you the scverse brand and dark mode, the shared sidebar layout, footer, and announcement banner, a "scverse packages" dropdown generated from the package registry, cross-links to every core package, the repository links ("edit this page" and the header icon), and the standard extension stack.

Every piece also works on its own. For the theme without the extension stack or the shared defaults, select it and leave extensions alone – it is a registered Sphinx theme, so installing the package is enough:

html_theme = "scverse"

source_repository = "https://github.com/scverse/pertpy"

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:

1. Add the latest release of scverse-doc from PyPI to your uv project:

   uv add 'scverse-doc[full]'
   

2. Install the latest release into a standard virtual environment:

   (after activating your venv)
   pip install 'scverse-doc[full]'
   

3. Install the latest development version:

   pip install 'scverse-doc[full] @ git+https://github.com/scverse/scverse-doc.git'  # (or `uv add`)
   

The full extra is what extensions = ["scverse_doc"] needs. For less, pick from the theme extra (for html_theme = "scverse") and the config extra (for scverse_doc.config’s extension stack). scverse_doc.autodoc, scverse_doc.napoleon, scverse_doc.registry and scverse_doc.source need no extra.

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