rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
In the Ruby core repository, all errors get automatically linked except [LoadError](https://docs.ruby-lang.org/en/master/LoadError.html). For example, the following RDoc: ``` LoadError SyntaxError ``` Generates: I'm on RDoc 6.7.0.
## Problem Currently, running `bundle exec rdoc` in the repository root causes the following error: ``` uh-oh! RDoc had a problem: Directory doc already exists, but it looks like it...
Rails recently moved some includes from being dynamic to explicit in https://github.com/rails/rails/pull/52185 which means rdoc was now able to document a bit more. This had the side-effect of rdoc taking...
This implements option 2 in #1107, which is to use `extconf.rb` to conditionally run `rake generate` when the gem is installed as a git source. To make sure the target...
This code was for ruby 2.4 compatibility, but rdoc dropped support for ruby 2.4 about three years ago, in f480b970c. This code was almost half of the lines of code...
## Problem When I look into a source code of RDoc to debug, it's so hard to read it due to the lack of proper documentation. For example, https://github.com/ruby/rdoc/blob/master/lib/rdoc/parser.rb#L254 has...
### Context - RDoc uses parser generator `kpeg` for its markdown parser, which reads `lib/markdown.kpeg` to output `lib/markdown.rb`. - RDoc doesn't commit the generated `.rb` files, but relies on its...
[Sim Daltonism](https://michelf.ca/projects/sim-daltonism/) or similar tools can be used to visually inspect and verify what web pages look like to folks with various forms of colour vision deficiency. It would be...
### Problems There are following problems because of tight coupling between RubyGems and RDoc. 1. If there are braking changes in RDoc, RubyGems is also broken. 2. When we maintain...
