Skip to content

docs: move to scverse-doc and adopt the shared scverse docs TOC - #1385

Merged
Zethson merged 4 commits into
mainfrom
toc-structure
Nov 3, 2026
Merged

Zethson merged 4 commits into
mainfrom
toc-structure

Conversation

@Zethson

@Zethson Zethson commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Changes

  • Switches the docs from furo to scverse-doc and groups the sidebar into Getting started, Guides, Reference and Project as agreed in A new TOC structure scverse-doc#62, with the getting-started notebook as the quickstart.

The docs switch from furo to scverse-doc: conf.py drops what its extension stack and defaults already set (keeping MyST substitutions), the core packages' inventories come from its registry, its napoleon replaces the typed_returns extension, and the light and dark logos move to pydata's logo options.
furo's Font Awesome stylesheet for its footer icons goes with furo.
The accents come from the registry once scverse/scverse.github.io#380 and a scverse-doc release carry CellRank's navy and blue; until then the docs use the scverse blue.

The sidebar follows the structure agreed in scverse/scverse-doc#62: Getting started (installation, the getting-started notebook as the quickstart), Guides (tutorials), Reference (API, about, moving to v2) and Project (release notes, contributing, citation, bibliography, team, GitHub and Discourse).
"Citing CellRank" and "References" become "Citation" and "Bibliography".

Built on Python 3.13: 473 warnings against main's 479, none new.
0.4.0 carries the registry accents and renders math at build time with math-core.
scverse-doc 0.4 renders math with math-core by default, and sphinx-tippy refuses tippy_enable_mathjax unless MathJax is the renderer.
@Zethson
Zethson requested a review from Marius1311 November 2, 2026 15:36
The cookiecutter template adds the local extensions directory to sys.path and loads every module in it; conf.py keeps that, so a local extension can be added without touching the setup.

@Marius1311 Marius1311 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@Zethson
Zethson merged commit e5a5df4 into main Nov 3, 2026
7 of 13 checks passed
@Marius1311
Marius1311 deleted the toc-structure branch November 4, 2026 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants