Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Documentation

Tools for generating API documentation.

This directory contains various tooling required to build project API documentation. To generate a local build, enter the following command from the top-level project directory,

$ DEBUG=* node ./path/to/docs/api/build-docs/bin/cli

To view generated docs, open a second terminal and navigate to

$ cd ./path/to/stdlib/build/www/public

Once in the build destination directory, run

$ python -m SimpleHttpServer 9000

and open

http://127.0.0.1:9000

in a browser.