Open Source Ruby Documentation Software

With the new dynamic documentation server in YARD 0.6, you can now see exactly what YARD sees as you document your code. Simply type yard server, reload to have your project watch for changes in your codebase everytime you refresh the page. With this functionality, you almost have no excuse not to write documentation! You can write all kinds of extensions in YARD, including ones that can understand all of the dynamic magic your framework does in its own little Domain Specific Languages (DSLs). Most importantly, it's really easy to do! There are already plugins that support frameworks like RSpec, DataMapper, Sinatra, and support for others are in the works. YARD is the only Ruby documentation tool that supports storing metadata alongside your documentation. This metadata can be used to create consistent documentation in any format you wish. YARD also comes with a powerful templating system to quickly modify existing templates.

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.

The devdocs repository powers the DevDocs web application, a fast, offline-friendly documentation browser for many programming languages, libraries, and APIs. It aggregates documentation from multiple sources (e.g., MDN, Python, Ruby, Git, etc.), converts them into a uniform format, and indexes them for instant text searching. The codebase includes a backend that handles ingestion, parsing, and transformation of documentation sources into a static site structure, as well as the client side UI code for browsing, searching, and reading docs in a responsive interface. DevDocs supports offline usage: users can download sets of docs for use without an internet connection, benefiting from caching and compact compressed storage. The repository includes scripts for updating doc sources, building, and deploying the documentation site. Because it is meant as a reference tool, performance and usability (e.g. fast search, minimal latency) are emphasized in design.

This is unofficial documentation of the Tesla JSON API used by their iOS and Android apps. It features functionality to monitor and control their vehicle (Models S, 3, X, Y) and power (Powerwall) products. We currently have documentation for their vehicles, but always accept pull requests for improvements and additions. The API for vehicles is organized into 3 primary surfaces. This gem provides a basic wrapper around the API to easily query and command the car remotely. It also provides access to the streaming API and a means to process data coming from it. Gives point-in-time data about the state of the vehicle and basic controls over certain functions of the vehicle. The state and command APIs loosely adhere to the REST standard, but differ in some crucial ways. As a result, you may not be able to use it with many REST tools and libraries out of the box.

deplate is a tool for converting wiki-like markup to latex, docbook, html, or "html-slides". It supports embedded LaTeX code, footnotes, citations, biblographies, automatic generation of an index etc.

JarHunt is a simple Ruby/Rails app that allows you to upload and catalog jar files that you work with every day. The jar files are then searchable, making tracking down which class files belong to which java archive easy and fast.

API documentation generator for Sencha JavaScript frameworks. JSDuck aims to be a better documentation generator for Ext JS than the old ext-doc was. It is used by Sencha to document Ext JS 4, Sencha Touch and several other products. NB! Windows binaries are now hosted in Github: https://github.com/senchalabs/jsduck/releases

jazzy is a command-line utility that generates documentation for Swift or Objective-C. Instead of parsing your source files, jazzy hooks into Clang and SourceKit to use the AST representation of your code and its comments for more accurate results. The output matches the look and feel of Apple’s official reference documentation, post WWDC 2014. Jazzy can also generate documentation from compiled Swift modules using their symbol graph instead of source code. You need development tools to build the project you wish to document. Jazzy supports both Xcode and Swift Package Manager projects. Jazzy expects to be running on macOS. Run jazzy from your command line. Run jazzy -h for a list of additional options. Swift documentation is written in markdown and supports a number of special keywords. You can set options for your project’s documentation in a configuration file, .jazzy.yaml by default.

KSS attempts to provide a methodology for writing maintainable, documented CSS within a team. Specifically, KSS is a documentation specification and styleguide format. It is not a preprocessor, CSS framework, naming convention, or specificity guideline. Documentation is all about communication. Between people, not computers. So why should your documentation format cater to computers? KSS’s documentation syntax is human readable, but just structured enough to be machine parsable. KSS is designed to work with every flavor of CSS out there, preprocessor or not. Choose whatever works for you. Create example HTML for your CSS and automatically generate variations of each element. Ever wanted to see the hover, active, and visited states for a link all at once? The methodology and ideas behind Knyle Style Sheets are contained in SPEC.md.

This project is defunct. Please use rDoc for your documentation.

TibcoBWDoc is a simple documentation generation tool that generates documentation on HTML format from a TIBCO BusinessWorks project. The output includes information about processes, packages, global variables and resources

Defects/Tasks/Documentation Tracking system using Ruby On Rails and multiple DB engines (MySQL, Postgresql, Oracle).

A documentation generator for the C Object System.