eol pages for github
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
classes
files
README.rdoc
created.rid
fr_class_index.html
fr_file_index.html
fr_method_index.html
index.html
rdoc-style.css

README.rdoc

EOL Project Documentation

eol.github.com shows the generated RDoc documentation for the EOL project, github.com/eol/eol

EOL core team members can regenerate the documentation found here by running script/publish_rdoc from the root of the EOL project

Usage: ./script/public_rdoc path-to-cloned-eol.github.com-repository

github.com/eol/eol/blob/master/script/publish_rdoc

We're currently using the Allison template: blog.evanweaver.com/files/doc/fauna/allison/files/README.html

We previously used the Hanna template: github.com/mislav/hanna/tree/master

Allison's filter mechanism is very handy for quickly finding classes, files, and methods.

NOTE: we might want to think about customizing an RDoc template to be styled like www.eol.org. A great example of styling RDoc to match a website: code.macournoyer.com/thin/doc/files/README.html