From 754747f20bb43112dd8cb823eba347f45b7f6f36 Mon Sep 17 00:00:00 2001 From: Nicolas Hug Date: Wed, 19 Jun 2024 12:28:34 +0100 Subject: [PATCH] Update readme with instructions --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c59fbf2f..eab7f611 100644 --- a/README.md +++ b/README.md @@ -53,4 +53,9 @@ make html The built docs will be in `build/html`. Open in your browser to view them. +To avoid building the examples (which execute python code and can take time) you +can use `make html-noplot`. To build a subset of specific examples instead of +all of them, you can use a regex like `EXAMPLES_PATTERN="plot_the_best_example*" +make html`. + Run `make clean` from time to time if you encounter issues.