Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-10 08:02:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
overte/tools/jsdoc
History
Anthony Thibault 9a0163f404 Add README.md file to tools/jsdoc/out directory to prevent jsdoc generation failures during build
2019-02-19 10:36:35 -08:00
..
out Add README.md file to tools/jsdoc/out directory to prevent jsdoc generation failures during build 2019-02-19 10:36:35 -08:00
plugins Add "Avatar Script" JSDoc API classification 2019-02-12 11:49:49 +13:00
.gitignore Add README.md file to tools/jsdoc/out directory to prevent jsdoc generation failures during build 2019-02-19 10:36:35 -08:00
CMakeLists.txt added root.js to cmake build 2018-05-29 15:39:04 -07:00
config.json JS scripting console auto-complete 2018-01-19 19:11:12 +01:00
gravPrep.js JSDoc > Grav directory change 2019-01-11 14:38:20 -08:00
package.json fixed undefined errors 2018-05-07 15:49:53 -07:00
README.md Fixed Readme instructions on JSDoc 2018-07-02 10:59:08 -07:00
root.js Moved jsdoc folder from scripts to tools directory 2016-11-10 09:33:56 -08:00

README.md

#JavaScript Documentation Generation

##Prerequisites

  • Install node.js.
  • Install jsdoc via npm. npm install jsdoc -g

If you would like the extra functionality for gravPrep:

  • Run npm install

To generate html documentation for the High Fidelity JavaScript API:

  • cd tools/jsdoc
  • jsdoc root.js -c config.json

The out folder should contain index.html.

To generate the grav automation files, run node gravPrep.js after you have made a JSdoc output folder.

This will create files that are needed for hifi-grav and hifi-grav-content repos

The md files for hifi-grav-content are located in out/grav/06.api-reference.

The template twig html files for hifi-grav are located out/grav/templates.

if you would like to copy these to a local version of the docs on your system you can run with the follows args:

  • node grav true "path/to/grav/" "path/to/grav/content"