docs: publish REGISTRY.md + REPORTING.md as in-site Sphinx pages (MyST)#652
Open
igerber wants to merge 1 commit into
Open
docs: publish REGISTRY.md + REPORTING.md as in-site Sphinx pages (MyST)#652igerber wants to merge 1 commit into
igerber wants to merge 1 commit into
Conversation
Overall Assessment✅ Looks good. No unmitigated P0/P1 findings. Executive Summary
Methodology
Code Quality
Performance
Maintainability
Tech Debt
Security
Documentation/Tests
|
The two methodology markdown pages render on RTD under a new Methodology toctree section, so API-doc cross-refs use :doc: links instead of off-site blob/main GitHub URLs (stable-docs readers landed on a different revision than their installed version). myst-parser joins the docs dependency set (pyproject docs extra, RTD post_install, docs-tests workflow — kept in sync); all other repo-internal markdown under docs/ (performance notes, paper reviews, roadmaps, tutorials README) is explicitly excluded from the build. Latent defects surfaced by -W and fixed: a ToC anchor typo in REGISTRY.md (#differenceinifferences — broken on GitHub too), an H1->H3 heading jump, and the 'Diagnostics & Sensitivity' heading retitled to 'and' because GitHub and docutils slug '&' differently (double vs collapsed hyphen). Clean local make -C docs html SPHINXOPTS=-W: 0 warnings. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
d21b632 to
63d7eec
Compare
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.
Summary
docs/methodology/REGISTRY.mdandREPORTING.mdas in-site RTD pages (MyST) under a new Methodology toctree section, closing the TODO row: API-doc cross-refs now use:doc:links instead of off-siteblob/mainGitHub URLs, so stable-docs readers no longer land on a different revision than their installed version (docs/api/business_report.rst,diagnostic_report.rstconverted; the two tutorial notebooks keep their functional GitHub links — editing executed notebooks for a link swap wasn't worth the re-execution churn).myst-parser>=2.0added to all three synced dependency surfaces (pyprojectdocsextra,.readthedocs.yamlpost_install,docs-tests.ymlpip lines). All other repo-internal markdown underdocs/(performance notes — deliberately not on RTD per repo convention — paper reviews, roadmaps, tutorials README) is explicitly excluded from the Sphinx build, so nothing internal leaks onto RTD and no orphan warnings fire.-Wrisk didn't materialize: the 4.5k-line REGISTRY renders clean withdollarmath/amsmath+myst_heading_anchors=4. The build surfaced three latent doc defects, now fixed: a ToC anchor typo (#differenceinifferences— broken on GitHub too), an H1→H3 heading-level jump, and the "Diagnostics & Sensitivity" heading retitled to "Diagnostics and Sensitivity" (GitHub slugs&as a double hyphen; docutils collapses consecutive hyphens in ids — no single anchor spelling can satisfy both, so the title now slugs identically everywhere). Repo-wide grep confirms no other references to the old anchor.make -C docs html SPHINXOPTS="-W"— 0 warnings (same command as the docs-tests CI job).Methodology references (required if estimator / math changes)
Validation
docs-tests.ymlsphinx-build job under-W)-Wbuild logSecurity / privacy
Generated with Claude Code