orbit doc

NAME

doc - generate a project's documentation

SYNOPSIS

orbit doc [options]

DESCRIPTION

Generates documentation for a project and all of its dependencies based on inline markdown comments.

Documentation is extracted from comments embedded in the source code. A comment on the immediate line above a documentable item will be treated as that item's documentation, unless a comment is found on the exact line of the documentable item. Multiple lines of comments can represent a documentable item as long as there are no lines between the comments that is not a comment. Comments used for document generation are interpreted as Markdown.

The BROWSER environment variable is required to be set when using the --open flag.

OPTIONS

--open
            Open the docs in a browser after the operation

--no-deps
            Don't build documentation for dependencies

--document-private-units
            Document private units

--target-dir <dir>
            Directory for all generated artifacts and intermediate files

EXAMPLES

orbit doc
orbit doc --no-deps