Skip to content

Conversation

@Shivam-Bhardwaj
Copy link

Summary

This PR addresses issue #4209 by fixing broken links found by make linkcheck.

Changes

  1. conf.py: Added linkcheck_ignore and linkcheck_anchors_ignore patterns for:

    • Sites that block automated requests (403 errors): Zazzle, Raspberry Pi, Intel, Science.org, linux.die.net
    • Matrix.to links (non-standard anchor format)
    • SSL-problematic sites (pyyaml.docsforge.com, www2.cs.sfu.ca)
    • GitHub line number anchors (which change frequently)
  2. Release notes (8 files): Fixed internal relative links:

    • Changed ../../{distro}/Installation.html to absolute https://docs.ros.org/en/{distro}/Installation.html
  3. Tutorial/Guide fixes:

    • Fixed broken cyberbotics.com anchor links
    • Fixed IBM Cloud documentation links with invalid anchors
    • Fixed rmw_fastrtps README anchor
    • Fixed ament_lint_auto anchor
    • Fixed rosdistro CONTRIBUTING.md anchor
    • Updated Ubuntu 20.04 download URL (focal/daily-live/pending → releases.ubuntu.com)
    • Replaced broken SFU unix guide with Ubuntu command line tutorial

Testing

  • make html builds successfully
  • sphinx-lint source passes
  • doc8 source passes
  • make spellcheck passes

Notes

This is a partial fix for #4209. The full list of broken links is extensive (100+), and many are in historical release notes pointing to GitHub commits/PRs that have been deleted or moved. This PR focuses on the most impactful fixes for tutorials, how-to guides, and configuration.

Closes #4209

- Add linkcheck_ignore patterns for sites returning 403 errors
- Add linkcheck_anchors_ignore for GitHub line number anchors
- Fix internal relative links to use absolute docs.ros.org URLs
- Fix broken anchor links in various documentation files
- Update deprecated/moved external URLs

This is a partial fix for issue ros2#4209. Addresses the most impactful
broken links in tutorials, how-to guides, and release notes.
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.

make linkcheck finds many broken links

1 participant