Skip to content

Docs: furo theme, and a Getting started section with Installation and First alignment pages - #33

Open
wei-lingfeng wants to merge 3 commits into
MovingUniverseLab:devfrom
wei-lingfeng:furo-docs
Open

wei-lingfeng wants to merge 3 commits into
MovingUniverseLab:devfrom
wei-lingfeng:furo-docs

Conversation

@wei-lingfeng

@wei-lingfeng wei-lingfeng commented Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

Switches the documentation theme from sphinx_rtd_theme to furo, and splits the home page into a landing page, an Installation page and a First alignment page.

Theme

  • docs/conf.py: html_theme = 'furo', with html_title set to "FlyStar ".
  • docs/conf.py: furo's sidebar lists only the page titles. A html-page-context hook builds it from the toctree three levels deep and expanded, as navigation_depth=3 and collapse_navigation=False did with sphinx_rtd_theme.
  • docs/conf.py: the "edit this page" links use furo's source_repository, source_branch and source_directory, from the same repository URL in pyproject.toml.
  • docs/requirements.txt: furo in place of sphinx-rtd-theme.

Page structure

The home page held the summary, the installation instructions and the first example, and was listed in the sidebar as "Getting started". Installation and the first example are now separate pages under a "Getting started" caption:

  • index.rst keeps the summary, "How the pieces fit" and "Where to go next", which now also lists the two new pages.
  • installation.rst: the former Installation section.
  • first_alignment.rst: the former "A first alignment, start to finish" and "With your own data" sections, unchanged.
  • The "Which version is this?" note names dev, the branch the docs are built from, in place of mm_rework_lingfeng.
  • overview.rst and make_example_figures.py point to first_alignment.rst for the end-to-end example.
  • README.rst: the docs are built from dev (Read the Docs at /en/dev/, in place of /en/mm_rework_lingfeng/), and the reader starts at "Getting started" in the sidebar.

Sidebar: Getting started (Installation, First alignment), Components, Examples, API, Indices. The Components, Examples and API entries are unchanged.

Checks

  • The docs build with -W (warnings as errors).
  • Before the page split, the sidebar of the furo build had the same 101 entries, captions and nesting as the sphinx_rtd_theme build on the index, motion_models and alignment_example pages.
  • A build of this branch is at https://wei-lingfeng.github.io/flystar/ for review.

🤖 Generated with Claude Code

wei-lingfeng and others added 2 commits November 3, 2026 13:52
html_theme is furo instead of sphinx_rtd_theme. furo's sidebar lists only
the page titles, so a html-page-context hook builds it from the toctree
three levels deep and expanded, as sphinx_rtd_theme's navigation_depth=3
and collapse_navigation=False did: on the index, motion_models and
alignment_example pages the sidebar has the same 101 entries, captions and
nesting as the previous build. The GitHub "edit this page" links use furo's
source_repository, source_branch and source_directory, from the same
repository URL in pyproject.toml. docs/requirements.txt installs furo in
place of sphinx-rtd-theme.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
… alignment

- index.rst keeps the summary, "How the pieces fit" and "Where to go
  next", which now also lists the two new pages. It is no longer listed
  in the sidebar as "Getting started".
- The sidebar has a "Getting started" caption with two pages:
  installation.rst (the former Installation section) and
  first_alignment.rst (the former "A first alignment, start to finish"
  and "With your own data" sections, unchanged).
- The "Which version is this?" note names the dev branch, which the docs
  are built from, in place of mm_rework_lingfeng.
- overview.rst and make_example_figures.py point to first_alignment.rst
  for the end-to-end example.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@wei-lingfeng wei-lingfeng changed the title Docs: furo theme, with the same sidebar navigation as before Docs: furo theme, and a Getting started section with Installation and First alignment pages Nov 3, 2026

This branch has not been deployed

No deployments
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.

1 participant