Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix links and enable warning for missing links #459

Merged
merged 2 commits into from
Jul 19, 2024

Conversation

azeey
Copy link
Contributor

@azeey azeey commented Jul 17, 2024

🦟 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 setting nitpicky = True (see https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html). In general the changes are:

  • Where appropriate, change links that have versions to document links (e.g. /docs/blueprint/install to install). This lets sphinx know that this is a link to a document and can be verified.
  • Anchor links need a .md extension (e.g. install_ubuntu_src#building-the-ignition-libraries to install_ubuntu_src.md#building-the-ignition-libraries). I believe this is a limitation of the myst_parser plugin
  • Mark external links with a special syntax so sphinx can skip verifying them (e.g. [Sim](/api/sim/8/tutorials.html) to `Sim{.external})
  • Change full https links to documents (e.g. https://gazebosim.org/docs/all/contributing#repository-list to contributing.md#repository-list

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

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

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.

@azeey azeey requested a review from mabelzhang as a code owner July 17, 2024 20:56
@github-actions github-actions bot added 🌱 garden Gazebo Garden 🎵 harmonic Gazebo Harmonic 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🏰 citadel Ignition Citadel 📜 blueprint Ignition Blueprint 🔮 dome Ignition Dome labels Jul 17, 2024
@@ -28,7 +28,7 @@ At the time of writing, our recommendation is that new users install:

* [Ubuntu Jammy 22.04](https://www.releases.ubuntu.com/jammy/)
* [ROS 2 Humble Hawksbill](https://www.ros.org/reps/rep-2000.html#humble-hawksbill-may-2022-may-2027)
* [Gazebo Fortress](https://gazebosim.org/docs/fortress/install)
* [Gazebo Fortress](https://gazebosim.orginstall)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this link looks incorrect?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in 743aa7c. In a followup PR, I plan to add a step in the github workflow that uses sphinx's linkcheck builder to check if all external links are valid. Hopefully, that will catch more issues like this.

Signed-off-by: Addisu Z. Taddese <[email protected]>
@azeey azeey merged commit 6d32523 into gazebosim:master Jul 19, 2024
5 checks passed
@azeey azeey deleted the fix_links branch July 19, 2024 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 blueprint Ignition Blueprint 🏰 citadel Ignition Citadel 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🌱 garden Gazebo Garden 🎵 harmonic Gazebo Harmonic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants