Fix links and enable warning for missing links #459
Merged
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.
🦟 Bug fix
Summary
I had set
myst_all_links_external = True
to limit the number of changes in #441. This PR enables link checking by removing that paramater and settingnitpicky = True
(see https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html). In general the changes are:/docs/blueprint/install
toinstall
). This lets sphinx know that this is a link to a document and can be verified..md
extension (e.g.install_ubuntu_src#building-the-ignition-libraries
toinstall_ubuntu_src.md#building-the-ignition-libraries
). I believe this is a limitation of the myst_parser plugin[Sim](/api/sim/8/tutorials.html)
to `Sim{.external})This also fixes the links on https://gazebosim.org/docs/harmonic/tutorials/ where the link for "Building your own robots" incorrectly points to https://gazebosim.org/docs/harmonic/tutorials/building_robot instead of https://gazebosim.org/docs/harmonic/building_robot
Additional, I fixed a few missing links identified by the warnings after enabling them.
Checklist
codecheck
passed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-by
messages.