Documentation

Docrb is an opinionated documentation generator for Ruby projects.

YARD: Yay! A Ruby Documentation Tool Synopsis YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be e

Annotate (aka AnnotateModels) Add a comment summarizing the current schema to the top or bottom of each of your... ActiveRecord models Fixture files Tests and Specs Object Daddy exemplars Machinist b

Re:VIEW Re:VIEW is an easy-to-use digital publishing system for paper books and ebooks. Supported Formats Output formats Re:VIEW supports are: EPUB LaTeX InDesign (IDGXML) Markdown plain te

RDoc - Ruby Documentation System home github.com/rdoc/rdoc rdoc rdoc.github.io/rdoc bugs github.com/rdoc/rdoc/issues build status code quality

Hanna-nouveau¶ ↑ Based on the original Hanna by Mislav. Hanna-nouveau is an RDoc generator that scales. It's implemented in Haml, making the sources clean and readable. It's built with simplicity, beauty and ease of br

RSpec API Doc Generator Generate pretty API docs for your Rails APIs. Check out a sample. Changes Please see the wiki for latest changes. Installation Add rspec_api_documentation to your G

Table of Contents What is grape-swagger? Related Projects Compatibility Swagger-Spec Installation Usage Model Parsers Configure Routes Configuration Using Grape Entities Securing the Swagger

github-changelog-generator Changelog generation has never been so easy What’s the point of a changelog? Why should I care? Installation Running with Docker Output example Usage Params Pa

Documentation Documentation is a Rails engine which provides a complete system for managing a set of hierarchical documentation. Once installed in an application, you'll have a complete user interface for viewing as wel

Hologram Hologram is a Ruby gem that parses comments in your CSS and helps you turn them into a beautiful style guide. There are two steps to building a great style guide: Documenting your css and javascript,

Inch inch gives you hints where to improve your docs. One Inch at a time. Take a look at the project page with screenshots (live and in full color). What can it do? inch is a little bit like Code Climate

API Documentation Tool Apipie-rails is a DSL and Rails engine for documenting your RESTful API. Instead of traditional use of #comments, Apipie lets you describe the code, through the code. This brings adva