rdoc
rdoc copied to clipboard
RDoc produces HTML and online documentation for Ruby projects.
https://ruby-doc.org/stdlib-2.7.0/libdoc/rexml/rdoc/REXML/DTD/ElementDecl.html ```html s*(((([“‘]).*?”>5)|*)*?)(/)?>/um, true) ``` https://ruby-doc.org/stdlib-2.7.0/libdoc/net/ftp/rdoc/Net/FTP.html ```html The available options are: port Port number (default value is 21) ssl If options is true, then an attempt will be made to...
When I try to build documentation for the [google-api-client](https://github.com/googleapis/google-api-ruby-client) gem, the folder 'generated' of the gem takes too long time (about half of hour on middle freq PC) to generate...
Seems https://github.com/ruby/rdoc/blob/master/History.rdoc hasn't been updated in a long time. Same with https://github.com/ruby/rdoc/blob/master/TODO.rdoc It'd be nice of recent improvements and current plans were reflected there.
With Asciidoc, it is recommended to keep headings in order. That is to say, H4 should not follow H2, better for H3 to follow H2. If you break this it...
Asciidoc markup offers the option of variables, or "attributes" as they call them: https://asciidoctor.org/docs/user-manual#attributes it allows you to remove redundancy in a graceful way: ~~~ :q: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference - {q}/Global_Objects/Array/pop -...
If I run: ~~~ rdoc --main hello.rb ~~~ I can then visit **index.html**, which includes the documentation from **hello.rb** and also a search box and "Class and Module Index". However...
I believe that lib/rdoc/rubygems_hook.rb should be removed from RDoc in favor of its counterpart in RubyGems. RDoc does not need RubyGems for anything. OTOH, RubyGems requires RDoc for generating documentation....
I was working with RubyGems testing, and added `--enable=frozen-string-literal` to RUBYOPT. There were a few errors, all seemed to be due to RDoc. I then ran the test-all rdoc tests...