Skip to content

chore(docs): sphinx toctree audit#57

Open
hkimw wants to merge 1 commit intomainfrom
chore/sphinx-nav-audit
Open

chore(docs): sphinx toctree audit#57
hkimw wants to merge 1 commit intomainfrom
chore/sphinx-nav-audit

Conversation

@hkimw
Copy link
Copy Markdown
Member

@hkimw hkimw commented May 7, 2026

Summary

  • Audited the resolved Sphinx toctree graph for both EN and KO builds.
  • Found 0 unsuppressed pages missing from a toctree in both language builds.
  • Made no file moves and no documentation content changes; this branch contains an empty audit commit only.

Findings

Build Sphinx docs found Reachable from index toctrees Unsuppressed orphan pages
EN 91 89 0
KO 90 89 0

Intentional orphan pages observed:

  • EN not reachable by toctree but explicitly marked orphan: docs/releases/v0.1.0-alpha, plots/GALLERY_HEADER.
  • KO not reachable by toctree but explicitly marked orphan: docs/releases/v0.1.0-alpha.
  • 404 is explicitly marked orphan in both builds.
  • auto_plots/index is explicitly marked orphan but still reachable through docs/samples/index in both builds.

Sphinx build logs contained no document isn't included in any toctree warnings. Existing OpenGraph social-card font glyph UserWarning messages appeared during page writing, but they are unrelated to toctree reachability and did not fail strict mode.

Verification

  • PATH="$PWD/.venv/bin:$PATH" PY="$PWD/.venv/bin/python" make strict passed for EN and KO.
  • Cross-check used the generated Sphinx environment pickles from EN and KO builds, comparing env.found_docs against the closure of env.toctree_includes from master_doc, excluding documents with explicit orphan metadata.

Record the Sphinx toctree orphan audit result in the pull request body.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying pccx with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7a02238
Status: ✅  Deploy successful!
Preview URL: https://73644593.pccx.pages.dev
Branch Preview URL: https://chore-sphinx-nav-audit.pccx.pages.dev

View logs

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