8000 DOC Clarify Sphinx build instructions (#29743) · scikit-learn/scikit-learn@b5b24f8 · GitHub
[go: up one dir, main page]

Skip to content

Commit b5b24f8

Browse files
mozgitbetatim
andauthored
DOC Clarify Sphinx build instructions (#29743)
Co-authored-by: Tim Head <betatim@gmail.com>
1 parent 59a0b41 commit b5b24f8

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

doc/developers/contributing.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -955,8 +955,8 @@ To build the documentation, you need to be in the ``doc`` folder:
955955

956956
cd doc
957957

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:
960960

961961
.. prompt:: bash
962962

@@ -971,13 +971,16 @@ To also generate the example gallery you can use:
971971

972972
make html
973973

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`:
977977

978978
.. prompt:: bash
979979

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.
981984

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

0 commit comments

Comments
 (0)
0