Project

rdoc_link_checker

0.0
The project is in a healthy, maintained state
rdoc_link_checkerburdettelamar/rdoc_link_checkerHomepageDocumentationSource CodeBug TrackerWiki
Tool to check links in RDoc-generated HTML files.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
1,817
Stars
0
Forks
0
Watchers
3
 Releases
Current version
0.6.0
Total releases
6
First release
2023-05-18
Latest release
2023-05-25
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2023-05-26
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.14
minitest
~> 5.0
rake
~> 12.3.2
 Project Readme

RDocLinkChecker

A gem to find broken links in HTML files generated by Ruby RDoc.

Reports a link as broken if:

  • The target page given by +href+ is not found.

  • The target page is found, but the fragment given by +href+ is not a link target (element with attribute id) on that page; this usually causes a browser to open at the top of the page instead of at the given fragment.

    Some browsers are forgiving, and will open the target page at a link target similar to the given fragment; for example, fragment #bar may be opened at an element with id foobar.

See the help text.

Note: An RDoc bug that was fixed recently (PR ruby/rdoc#1002) caused many (make that many, many) broken links TOC section https://docs.ruby-lang.org/en/master/table_of_contents.html#classes. Unless you have a recent Ruby version installed (one that has the bug fix), the RDocLinkChecker will find and report all those broken links.

Workaround: Use option --no_toc, which suppresses checking for those links.