rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
``` 9982 $ ri File.new | tail -6 Optional keyword arguments opts specify: * {Open Options}[rdoc-ref:IO@Open+Options]. * {Encoding options}[rdoc-ref:encodings.rdoc@Encoding+Options]. 9983 $ ri rdoc-ref:IO@Open+Options Nothing known about rdoc-ref 9984 $ ri...
## Motivation Without being able to add SEO meta tags, such as `description` or `keywords`, documentation websites generated by RDoc often don't rank well in search engines. For example, Ruby's...
Commit 13e9a44896323535329331ffbc6c11813da53161 enforced parsing all files if any file is newer than the previous parse, not only updated files. However, this did not take into account the `--force-update` option and...
Hi! I think RDoc sometimes wrongly infers module ancestry and then methods can have cyclical `see` references. I encountered this error in the docs for GrpahQL-Ruby (fix: https://github.com/rmosolgo/graphql-ruby/pull/4819) and I...
Fixes https://bugs.ruby-lang.org/issues/20171 RDoc has a test code like this ```ruby assert_equal %w[Foo#Bar Foo::bar], @driver.complete('Foo.') ``` Reline doesn't accept this completion list because it does not start from `'Foo.'` To make...
Currently `rdoc-ref:REF@label` link is converted to `label at REF`, with the hardcoded word `at` and in the hardcoded order. For `doc/extension.ja.rdoc` written in Japanese in Ruby, this template needs to...
A class/module page documents its attributes in a section separate from that for its other instance methods. The TOC at the left links to the non-attribute methods, but not to...
I am seeing the following failure that happens randomly on Travis Ubuntu jammy ppc64le environment in ruby/ruby. The latest failure is at the relatively recent commit https://github.com/ruby/ruby/commit/1d51e4cadfbc1f445d00887189e06047759c9aec . https://app.travis-ci.com/github/ruby/ruby/jobs/612435804#L2936 ```...
File context.rb contains: ```ruby module Mod1 end module Mod2 Mod3 = Mod1 end ``` After executing `rdoc context.rb`: * the left "Class and Module Index" shows Mod3, Mod2, Mod3 *...
How to reproduce: Create the following files: ```ruby # test.rb module TestModule TEST_CONSTANT = 1108 def test_instance_method end end ``` ```markdown TestModule TestModule::TEST_CONSTANT TestModule#test_instance_method ``` Run the command: ```shell rdoc...
