Repository navigation
Docs: verify links in Markdown files - #13
Merged
Merged
Conversation
… external pass
- tools/check_docs.py checks every tracked (or new) Markdown file outside vendor/: inline
links, images, reference definitions, HTML href/src and bare URLs, with inline code and
comments masked.
- Targets must match a tracked file with the exact case; headings follow GitHub's slugs
(code spans and links in headings) and Pandoc {#id} attributes.
- Links to this repository on GitHub at master or the current version tag resolve in the
checkout; blob/main, relative links in the guides rendered on PyPI and crates.io and
undefined reference labels fail.
- --external requests every external URL (page anchors included); refusals by hosts and a
version tag not yet on GitHub are warnings.
- CONTRIBUTING.md and tools/README.md describe the check; the release steps run --external.
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.
tools/check_docs.pychecks every tracked (or new) Markdown file outsidevendor/. It reads inline links, images, reference definitions, HTMLhref/srcand bare URLs; links in code are ignored.{#id}attributes.github.com/mlapin/libsdca/blob/...atmasteror the current version tag resolve in the checkout, heading included.blob/main, relative links indocs/PYTHON.mdanddocs/RUST.md(rendered on PyPI and crates.io) and undefined reference labels fail.--externalrequests every URL in the Markdown,pyproject.toml,CITATION.cffandrust/Cargo.toml, and checks page anchors. 401/403/429 and a version tag not yet on GitHub are warnings.quality.pykeeps the offline check; the release steps inCONTRIBUTING.mdadd the external run.Known external failures, outside this PR:
https://mlapin.github.io/libsdca/report/returns 404, and theblob/v0.4.0links resolve oncev0.4.0is tagged.Checks:
tools/check_docs.pyand the documentation tests oftests/python/test_build_config.py.