Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-05-27 23:10:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
overte/tools/jsdoc
History
milad 4b4f6e0f02 cleaned up file cruft
2018-05-29 13:31:13 -07:00
..
plugins Merge commit 'refs/pull/13206/head' of https://github.com/highfidelity/hifi into gravprep-redo 2018-05-22 14:33:53 -07:00
.gitignore more cleanup 2018-05-29 09:35:22 -07:00
CMakeLists.txt Include JSDoc Web pages in the install 2018-04-16 16:08:26 +12:00
config.json JS scripting console auto-complete 2018-01-19 19:11:12 +01:00
gravPrep.js Cleaned up gravprep.js 2018-05-29 11:24:13 -07:00
package.json fixed undefined errors 2018-05-07 15:49:53 -07:00
README.md Cleaned up gravprep.js 2018-05-29 11:24:13 -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

Run npm install if you would like th extra functionality for gravPrep.

To generate html documentation for the High Fidelity JavaScript API:

  • cd tools/jsdoc
  • jsdoc . -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"