Skip to content

Commit

Permalink
Update readme with instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasHug committed Jun 19, 2024
1 parent 6d44bc0 commit 754747f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 754747f

Please sign in to comment.