jyapayne/ace
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix titles in API docs (via new Panino)

Browse source
This commit is contained in:
Garen Torikian 2012-08-28 16:08:28 -07:00
commit e4aa77dc3f
21 changed files with 45 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/README.md
View file

@ -2,7 +2,7 @@
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.
For any questions on the build system, please see that repo.
# Building
@ -15,14 +15,3 @@ In this directory, just run:
npm install
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