From 7d7bf2eae59991c812b0aab781f647965d1b704b Mon Sep 17 00:00:00 2001 From: Florian Spreckelsen <f.spreckelsen@indiscale.com> Date: Thu, 19 Dec 2024 16:57:06 +0100 Subject: [PATCH] DOC: Explain better how to build the docs --- README_SETUP.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README_SETUP.md b/README_SETUP.md index 9b8a6457..99b13956 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -80,13 +80,16 @@ See `build.properties.d/00_default.properties` for more information. ## Build the documentation # -Build documentation in `build/` with `make doc`. +Install the below requirements and build documentation in `build/` +with `make doc`. You may need to set the environment variables used in +`src/doc/Makefile`, especially `JSDOC_BIN` in case you didn't install +jsdoc globally. ### Requirements ## - sphinx - sphinx-autoapi - jsdoc (`npm install jsdoc`) -- jsdoc-sphinx (`npm install jsdoc-sphinx`) +- @indiscale/jsdoc-sphinx (`npm install @indiscale/jsdoc-sphinx`) - sphinx-js - recommonmark -- GitLab