Fix build error for template changes

This commit is contained in:
ingerjm0 2019-04-04 15:08:39 -07:00
parent 2b858c4ef5
commit 3dbb2b1812
2 changed files with 8 additions and 2 deletions

View file

@ -11,10 +11,17 @@ If you would like the extra functionality for gravPrep:
To generate html documentation for the High Fidelity JavaScript API:
* `cd tools/jsdoc`
* `jsdoc root.js -c config.json`
* `jsdoc root.js -r api-mainpage.md -c config.json`
The out folder should contain index.html.
If you get a "JavaScript heap out of memory" error when running the `jsdoc` command you need to increase the amount of memory
available to it. For example, to increase the memory available to 2GB on Windows:
* `where jsdoc` to find the `jsdoc.cmd` file.
* Edit the `jsdoc.cmd` file to add `--max-old-space-size=2048` after the `node` and/or `node.exe` commands.
Reference: https://medium.com/@vuongtran/how-to-solve-process-out-of-memory-in-node-js-5f0de8f8464c
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

View file

@ -1,6 +1,5 @@
{
"opts": {
"readme": "api-mainpage.md",
"template": "hifi-jsdoc-template"
},
"docdash": {