Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Documentation

Build API documentation.

Usage

var build = require( '@stdlib/_tools/docs/api/build-docs' );

build( done )

Builds documentation.

function done( error ) {
    if ( error ) {
        throw error;
    }
    console.log( 'Success!' );
}

build( done );

Examples

var build = require( '@stdlib/_tools/docs/api/build-docs' );

build( clbk );

function clbk( error ) {
    if ( error ) {
        throw error;
    }
    console.log( 'Success!' );
}

CLI

Usage

Usage: build-docs [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ DEBUG=* build-docs