I've got three Rails libraries documented:

[Rails 4.2.0 gem](https://msp-greg.github.io/rails_gem_4_2_0/index.html)

[Rails 5.0.0.1 gem](https://msp-greg.github.io/rails_gem/index.html)

All of the 'Rails Guides' are included (accessible from the 'Docs' list), 
and they link back to code objects, unlike other docs.

For people interested in contributing to Rails, see [Rails master 
branch](https://msp-greg.github.io/rails_master/index.html) - this set 
shows everything, which includes many 'non-public' objects.
<br/>
Rails is complicated, at least from the perspective of object structure.

Since learning Rails is one of my future goals, I decided to add code 
specific to Rails for a YARD plugin I've been working on.  It parses into 
most of the DSL code that Rails contains, which generates much more 
complete documentation.

As an example, look at 
[ActiveRecord::Base](https://msp-greg.github.io/rails_gem/ActiveRecord/Base.html).
 
 It has over 200 native methods, and several hundred methods in its call 
chain.  Since all of the methods are created via DSL code, normal 
documentation systems 
([RubyOnRails.org](http://api.rubyonrails.org/classes/ActiveRecord/Base.html)) 
show an 'empty' object.

The docs allow one to search for objects across all of Rails, and also 
allows one to search for methods within a class or module.  It also shows 
method chains in the search.

For example, searching 
[ActionController::Base](https://msp-greg.github.io/rails_gem/ActionController/Base.html)
 
for `process_action` methods shows the three methods in its call chain, in 
order of the calling.

Several versions of Ruby are on the site, along with the AWS SDK for Ruby. 
 Ruby has several docs, along with doc in the code.  For instance, 
[Methods](https://msp-greg.github.io/ruby_2_3/file.methods.html) and 
[Calling 
Methods](https://msp-greg.github.io/ruby_2_3/file.calling_methods.html).

See [home page](https://msp-greg.github.io/), also the [UI 
Guide](https://msp-greg.github.io/file.UI.html).  I've got code running 
'(repo) git pull - doc - git commit - (site) git push', so the site will 
stay current...

-- 
You received this message because you are subscribed to the Google Groups "Ruby 
on Rails: Talk" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to rubyonrails-talk+unsubscr...@googlegroups.com.
To post to this group, send email to rubyonrails-talk@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/rubyonrails-talk/ec608470-b445-4280-9853-9b4edf6dbee7%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to