NoahKusaba opened a new pull request, #2476: URL: https://github.com/apache/datafusion-ballista/pull/2476
# Rationale for this change Every intra-doc anchor link is dead on the published site. `myst_heading_anchors` was never set, so MyST emits no heading ids and all `file.md#heading` links 404. They resolve on GitHub, which is why nobody noticed. `sphinx-build` on `main` reports 16 warnings. # What changes are included in this PR? - Set `myst_heading_anchors = 4` in `docs/source/conf.py`. This fixes the 13 dead cross-references and changes how every Markdown page renders (heading ids are now emitted). - Fix the remaining three warnings: a short title overline in `index.rst`, `code-organization.md` starting at H2, and a link in `introduction.md` to a directory rather than a document. - `docs/build.sh`, which the docs deploy workflow runs, now builds with `-W --keep-going`, so a broken cross-reference fails the build instead of shipping. # Are there any user-facing changes? Links on the published docs site that 404 today will work. For contributors, the docs build now fails on warnings. Verified: `sphinx-build -W --keep-going` is clean, 0 warnings (16 on `main`). Note: this and the ruff PR both touch `docs/source/conf.py` on adjacent lines, so whichever lands second may need a trivial rebase. Split out of #2438 to make it easier to review. 🤖 Generated with [Claude Code](https://claude.com/claude-code) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
