rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
On ruby-core, a [suggestion was made](https://bugs.ruby-lang.org/issues/19613) to add version information to all function documentation. I think that making it easier to do in a standardized way would be good. In...
~~~ $ ruby -v ruby 3.2.0 (2022-12-25 revision a528908271) [x86_64-linux] $ gem install rdoc -v 6.5.0 $ gem install rdoc -v 6.4.0 $ wget https://cache.ruby-lang.org/pub/ruby/3.2/ruby-3.2.0.tar.gz $ tar xf ruby-3.2.0.tar.gz $...
This is just an early proof-of-concept, but the idea is that we can hold a reference to the following rails extensive attributes API so they can be displayed and searchable...
It may be helpful to have the fonts used in darkfish: https://github.com/ruby/rdoc/tree/master/lib/rdoc/generator/template/darkfish/fonts placed in a separate Gem. There are example gems for fonts including: https://rubygems.org/gems/discourse-fonts https://rubygems.org/gems/dejavu-fonts This would perhaps also...
I created https://github.com/ruby/rdoc/releases from tag and `gh release create`. But old versions that located before GitHub are imcomplete. We should fill them from `History.rdoc`
Fixes this bug ```ruby module Mod1 module Sub end end module Mod2 include Mod1 end module Mod3 include Mod2 include Sub # 'Mod1::Sub' is included, but RDoc thinks unknown constant...
I wanted to try RDoc methods and noticed there's no `bin` dir. This `bin/console` loads `doc/rdoc/markup_reference` for easy testing and debugging.
Potential fix for #1126. The code example previously doesn't finish at all, now it does it instantly. All existing tests pass, other than that I can't reason much more about...
I noticed that there's no list for directives. In fact, there's not a comprehensive user guide in English (the only I found was in Japanese: https://docs.ruby-lang.org/ja/latest/library/rdoc.html). Adding user guide has...
This attempts to close #1053 This is NOT meant to get merged soon, but the purpose is to confirm that this approach is correct. After getting some positive comments (hopefully),...