rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
Highlighting file paths like `lib/foo/bar.rb` should not be linked to the file automatically. If the writer's intention is to link it, `rdoc-ref` should be used.
I think it'd be beneficial for both the doc writer and consumer to be able to tell the version of the doc directly from the web page.
It's very common that documents contain code block with shell commands in it. And we can probably highlight them in the frontend through a simple highlighter if the code block...
Add the ability to look up documentation for global variables (e.g., $
`Complex#conjugate` have token_stream but marked as skip_document [Complex#conjugate](https://docs.ruby-lang.org/en/master/Complex.html#method-i-conjugate) has `▶︎Source` toggle but description is skipped. [Complex#conj](https://docs.ruby-lang.org/en/master/Complex.html#method-i-conj) has document but `▶︎Source` is not available. The behavior of this bug looks similar...
Some pages are primarily used as a linked reference but currently still take up space in the sidebar listing. RDoc should provide a way to hide them so we don't...
This patch improves the spacing of highlighted method details in generated RDoc pages. When a method anchor (for example, #method-i-force) is targeted, a left border is applied to the `.method-detail`...
Since it's possible to pass `code` param to `try.ruby-lang.org`/`ruby.github.io`, we can add links to it with the code block's code embedded in the parameter. Then the reader can easily play...