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:
-
Add the latest release of
scverse-docfrom PyPI to youruvproject:uv add 'scverse-doc[full]'
-
Install the latest release into a standard virtual environment:
(after activating your venv) pip install 'scverse-doc[full]'
-
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
1 maintainer
Metadata
1 maintainer
Release files for scverse-doc 0.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| scverse_doc-0.2.3.tar.gz | 49.3 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scverse_doc-0.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 95.1 kB
Release files / scverse_doc-0.2.3.tar.gz
| Download URL | scverse_doc-0.2.3.tar.gz |
|---|---|
| Size | 49.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
433fabf5cf770d0424db0e209c51bbbef38343b6dee310f3ca04553ccac52d5f
|
|
BLAKE2b-256 checksum How to use checksums |
5671425756b5145dfba90bf97e6450303589f5cd95676c3684267c68fed00261
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logRelease files / scverse_doc-0.2.3-py3-none-any.whl
| Download URL | scverse_doc-0.2.3-py3-none-any.whl |
|---|---|
| Size | 45.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1569c92c00331a34f389bbe8aff1096ba27dbbb8294c44171ee82550b8f3b67a
|
|
BLAKE2b-256 checksum How to use checksums |
6adf127df6cb352441820055a1a8ff931ea10ae94e95f4d73863257b34d69e88
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logSecurity for scverse-doc 0.2.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for scverse_doc-0.2.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
