Repository navigation
Docs: furo theme, and a Getting started section with Installation and First alignment pages - #33
Open
wei-lingfeng wants to merge 3 commits into
Open
wei-lingfeng wants to merge 3 commits into
wei-lingfeng wants to merge 3 commits into
Conversation
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]>
Co-Authored-By: Claude Opus 5.5 <[email protected]>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Switches the documentation theme from
sphinx_rtd_themetofuro, and splits the home page into a landing page, an Installation page and a First alignment page.Theme
docs/conf.py:html_theme = 'furo', withhtml_titleset to "FlyStar ".docs/conf.py: furo's sidebar lists only the page titles. Ahtml-page-contexthook builds it from the toctree three levels deep and expanded, asnavigation_depth=3andcollapse_navigation=Falsedid withsphinx_rtd_theme.docs/conf.py: the "edit this page" links use furo'ssource_repository,source_branchandsource_directory, from the same repository URL inpyproject.toml.docs/requirements.txt:furoin place ofsphinx-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.rstkeeps 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.dev, the branch the docs are built from, in place ofmm_rework_lingfeng.overview.rstandmake_example_figures.pypoint tofirst_alignment.rstfor the end-to-end example.README.rst: the docs are built fromdev(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
-W(warnings as errors).sphinx_rtd_themebuild on the index,motion_modelsandalignment_examplepages.🤖 Generated with Claude Code