From a13743fcaec4b9a90c9b2ce182a280e979ba7579 Mon Sep 17 00:00:00 2001 From: Luis Aleixo Date: Wed, 1 Jun 2022 15:49:37 +0200 Subject: [PATCH] Updated readme for compilation --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index e358a978..c0ee4f4a 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,14 @@ To run the calculator on a different URL path: python -m cara.apps.calculator --prefix=/mycalc ``` +### How to compile and read the documentation + +In order to generate the documentation, CARA must be installed first. + +If any of the `.rst` files under the `cara/docs` folder is changed, the command `make html` should be executed in the docs directory. + +Then, right click on `cara/docs/index.rst` and select `Open with` your preferred web browser. + ### Running the CARA Expert-App app in development mode ```