Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 691 Bytes

README.md

File metadata and controls

20 lines (15 loc) · 691 Bytes
Raw

API documentation

Ringo's API documentation is based on a custom JSDoc parser based on the legacy JSDoc package.

Build and run

You have to clone the RingoJS repository to generate the API documentation. In the example, the ringo/ringojs repository is cloned into ~/Code/ringojs/. The generated files will be saved to the output directory. Make sure that the output directory is empty before running the generator.

docker build -t ringojs/apidoc .

docker run -it --rm \
    -v ~/Code/ringojs/:/var/ringojs/:ro \
    -v $(pwd)/output/:/var/output/ \
    ringojs/apidoc