mojito-cli-doc

mojito-docs

Generate API documentation for mojito, mojito apps, or mojits. Uses yuidoc.

Install

This package provides the doc command for the mojito-cli tool. Install mojito-cli to use the mojito doc command.

Usage

To generate documentation for a mojito application, including all mojits in it's mojits/ sub-directory, run the following from the application directory:

$ mojito docs app

To generate documentation for a specific mojit, run the following from the application directory:

$ mojito docs mojit <mojit-name>

To generate documentation for the Mojito framework itself:

$ mojito docs mojito

Options

Specify output directory:

--directory <path>
-d <path>

Serve the API docs over HTTP, without rendering them to the file system:

--server
-s

Serve the API docs over HTTP on the specified port number. Assumes --server:

--port <number>
-p <number>

Discussion/Forums

http://developer.yahoo.com/forum/Yahoo-Mojito

Licensing and Contributions

mojito-cli-doc is licensed under a BSD license (see LICENSE.txt). To contribute to the Mojito project, please see Contributing.

The Mojito project is a meritocratic, consensus-based community project which allows anyone to contribute and gain additional responsibilities.