File tree 1 file changed +9
-6
lines changed 1 file changed +9
-6
lines changed Original file line number Diff line number Diff line change @@ -955,8 +955,8 @@ To build the documentation, you need to be in the ``doc`` folder:
955
955
956
956
cd doc
957
957
958
- In the vast majority of cases, you only need to generate the full web site,
959
- without the example gallery:
958
+ In the vast majority of cases, you only need to generate the web site without
959
+ the example gallery:
960
960
961
961
.. prompt :: bash
962
962
@@ -971,13 +971,16 @@ To also generate the example gallery you can use:
971
971
972
972
make html
973
973
974
- This will run all the examples, which takes a while. If you only want to generate a few
975
- examples, which is particularly useful if you are modifying only a few examples, you can
976
- use :
974
+ This will run all the examples, which takes a while. If you only want to generate
975
+ images for a few examples, you can pass their names (or parts of) to the build command.
976
+ The line below will run all examples with names starting with ` plot_calibration ` :
977
977
978
978
.. prompt :: bash
979
979
980
- EXAMPLES_PATTERN=your_regex_goes_here make html
980
+ EXAMPLES_PATTERN="plot_calibration" make html
981
+
982
+ You can also pass regular expressions to gain more advanced control over examples
983
+ you want run.
981
984
982
985
Set the environment variable `NO_MATHJAX=1 ` if you intend to view the documentation in
983
986
an offline setting. To build the PDF manual, run:
You can’t perform that action at this time.
0 commit comments