8000 DOC Tweak documentation build doc (#29749) · glemaitre/scikit-learn@1e27444 · GitHub
[go: up one dir, main page]

Skip to content

Commit 1e27444

Browse files
lestevebetatim
authored andcommitted
DOC Tweak documentation build doc (scikit-learn#29749)
Co-authored-by: Tim Head <betatim@gmail.com>
1 parent 55b3607 commit 1e27444

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

doc/developers/contributing.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -945,16 +945,14 @@ To also generate the example gallery you can use:
945945

946946
make html
947947

948-
This will run all the examples, which takes a while. If you only want to generate
949-
images for a few examples, you can pass their names (or parts of) to the build command.
950-
The line below will run all examples with names starting with `plot_calibration`:
948+
This will run all the examples, which takes a while. You can also run only a few examples based on their file names.
949+
Here is a way to run all examples with filenames containing `plot_calibration`:
951950

952951
.. prompt:: bash
953952

954953
EXAMPLES_PATTERN="plot_calibration" make html
955954

956-
You can also pass regular expressions to gain more advanced control over examples
957-
you want run.
955+
You can use regular expressions for more advanced use cases.
958956

959957
Set the environment variable `NO_MATHJAX=1` if you intend to view the documentation in
960958
an offline setting. To build the PDF manual, run:

0 commit comments

Comments
 (0)
0