docs: migrate documentation to themed Sphinx site - #3280
Draft
TomCC7 wants to merge 6 commits into
Draft
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## sam/sphinx-setup #3280 +/- ##
=================================================
Coverage 73.64% 73.65%
=================================================
Files 1068 1068
Lines 99443 99445 +2
Branches 9124 9125 +1
=================================================
+ Hits 73239 73249 +10
+ Misses 23604 23595 -9
- Partials 2600 2601 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 3 files with indirect coverage changes 🚀 New features to boost your workflow:
|
| bitrate | ||
| bringup | ||
| cancelled | ||
| cancelling |
Contributor
There was a problem hiding this comment.
cancelling is British
canceling is American
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
2 participants
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.
Stack
sam/sphinx-setup).Problem
Sam's PR establishes the Sphinx structure, but the documentation still needs usable
navigation, API cross-references, code-block references, and a production-quality theme.
The team also wants to keep authoring prose in Markdown and retain the Mintlify build
during the Sphinx transition.
Solution
docs/api.rstfor the autodoc-heavy generated API referenceand visual treatment with the hosted Dimensional docs
sphinx-designcardsdocs-old/, including local preview, validation,and static export on Node 22
docs-old/from the canonical documentation link resolver.rstto.mdDocumentation prose was kept unchanged wherever possible; changes are primarily format
conversion, reference activation, navigation, and presentation.
How to test
Sphinx
Open http://localhost:8000/.
Mintlify fallback
Use Node 22:
cd docs-old npm ci npm run validate npm run build npm run devValidation
57 passedindimos/utils/docs/test_doclinks.pygit diff --checkThe spelling builder remains enabled in CI, where the
en_USEnchant dictionary isinstalled explicitly.
AI assistance
Codex with GPT-5 was used extensively for mechanical conversion, Sphinx reference
activation, theme and navigation work, diagnosis, and validation. The changes were
directed and reviewed interactively by the author.
Checklist