Documentation Generators
Tools for creating API documentation of your Ruby software and it's exposed interfaces
4.32
RDoc produces HTML and command-line documentation for Ruby projects.
RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
4.31
YARD is a documentation generation tool for the Ruby programming language.
It enables the user to generate consistent, usable documentation that can be
exported to a number of formats very easily, and also supports extending for
custom Ruby constructs such as custom class level definitions.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
1.53
rdoc generator html with javascript search index.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
1.44
Rails REST API documentation tool
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
1.43
Inspired by TomDoc, KSS attempts to provide a methodology for writing
maintainable, documented CSS within a team. Specifically, KSS is a CSS
structure, documentation specification, and styleguide format.
This is a ruby library for parsing KSS documented CSS and generating
styleguides.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
1.01
Generate API docs from your test suite
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.71
Pretty documentation generator for Github projects with proper Readme.
Activity
0.52
Builds manuals
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.21
Docco in Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.13
Converts markdown into UNIX manpages and HTML webpages.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.05
TomDoc is flexible code documentation with human readers in
mind. The tomdoc gem is a Ruby library to discover and display
TomDoc'd methods and classes.
Given a Ruby file with TomDoc'd methods, tomdoc can generate HTML or
print to the console. You can use it to query up a single method or
a group of methods, and it's usable from irb.
If you're using TomDoc, tomdoc is for you.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.03
RDoc generator designed with simplicity, beauty and ease of browsing in mind
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.03
Rdoc template and generator for Ruby source code that uses javascript to make searching for methods and classes very easy.
0.02
Use TomDoc documentation format with YARD.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.02
schemadoc - document your database schemas (tables, columns, etc.)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.02
Annotate your models and keep your comments about fields.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.01
Generate `Rakefile` with `docr` and get searchable documentation for ruby, rails, gems, plugins and all other ruby code in one place
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity
0.01
Produces UNIX manual pages for executable scripts.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
0.0
ERBook 9.2.1
Write books, manuals, and documents in eRuby
http://snk.tuxfamily.org/lib/erbook/
ERBook is an extensible document processor that emits [1]any
document you can imagine from [2]eRuby templates, which allow
scripting and dynamic content generation.
Version 9.2.1 (2009-11-18)
This release fixes some bugs in, and improves the readability
and load time of, generated XHTML documents.
Bug fixes
* Prevent search button from starting search when search
box untouched.
* Prevent browser from fetching base-64 embedded URI
sources by qualifying their digests with the "cid" URI
schema, which is used to identify the parts of a
multi-part e-mail message.
This cuts down on the amount of "404 - File Not Found"
errors on the web server which hosts your generated XHTML
documents because web browsers will not confuse these
embedded "cid" digests as being relative HTTP files.
Housekeeping
* Increase vertical spacing between [3]References for
better readability.
* Embed W3C validator badges as base-64 data URIs to reduce
page load time.
* Split the document processing code in ERBook::Document
into smaller self-documenting methods.
References
1. http://snk.tuxfamily.org/lib/erbook/#HelloWorld
2. http://en.wikipedia.org/wiki/ERuby
3. http://snk.tuxfamily.org/lib/erbook/#_references
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
Activity