Force higher (fixed) Panino; remove needless package.json

This commit is contained in:
Garen Torikian 2012-04-29 18:22:02 -07:00
commit d32dfd3194
23 changed files with 72 additions and 70 deletions

View file

@ -1,11 +1,27 @@
# Introduction
The beginnings of an API documentation set for Ace.
The API doc build takes a look a source Javascript files in the _lib_ directory, and turns it into HTML output in the _api_ directory. It uses [Panino](https://github.com/gjtorikian/panino-docs) to perform the conversion.
For any questions, please see that repo.
# Building
In this directory, just run
In the root directory, just run:
node build.js [path_to_ndoc]
make doc
`[path_to_ndoc]` is a required argument, indicating the location of your ndoc install, relative to the `build.js` file. By default, this will point to `./build/ndoc/bin/ndoc`.
In this directory, just run:
node build.js
# Build File
Here's a breakdown of what the arguments in _build.js_ are doing:
`--path=srcPath`: The location of the Ace source
`-o=../api/`: The location of the output
`-a=./additionalObjs.json`: A list of URLs to use for "missing objects" that the documentation requires
`-i=index.md`: The location of the Ace index/landing page
`-t=Ace API`: The title of the documentation
`--skin=./resources/ace/`: The location of all the templates and design
`-s`: Choose to split each class into its own file