From 3dbb2b18121a3c2646ca5ab4c4aa571faf49d70a Mon Sep 17 00:00:00 2001 From: ingerjm0 Date: Thu, 4 Apr 2019 15:08:39 -0700 Subject: [PATCH] Fix build error for template changes --- tools/jsdoc/README.md | 9 ++++++++- tools/jsdoc/config.json | 1 - 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/tools/jsdoc/README.md b/tools/jsdoc/README.md index f9864a21e4..8526bccc4e 100644 --- a/tools/jsdoc/README.md +++ b/tools/jsdoc/README.md @@ -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 diff --git a/tools/jsdoc/config.json b/tools/jsdoc/config.json index d5760b0332..5074362225 100644 --- a/tools/jsdoc/config.json +++ b/tools/jsdoc/config.json @@ -1,6 +1,5 @@ { "opts": { - "readme": "api-mainpage.md", "template": "hifi-jsdoc-template" }, "docdash": {