Skip to content

Commit d9f6846

Browse files
YosuaMichaelfacebook-github-bot
authored andcommitted
[fbsync] Document make html-noplot as the default doc building method (#5847)
Reviewed By: jdsgomes, NicolasHug Differential Revision: D36095703 fbshipit-source-id: 4c5e3305339f4a64d12546e77697b9d83270dddd
1 parent f4801ee commit d9f6846

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ pip install -r requirements.txt
159159

160160
```bash
161161
cd docs
162-
make html
162+
make html-noplot
163163
```
164164

165165
Then open `docs/build/html/index.html` in your favorite browser.
@@ -173,13 +173,13 @@ clean``.
173173

174174
#### Building the example gallery - or not
175175

176-
When you run ``make html`` for the first time, all the examples in the gallery
177-
will be built. Subsequent builds should be faster, and will only build the
178-
examples that have been modified.
176+
In most cases, running `make html-noplot` is enough to build the docs for your
177+
specific use-case. The `noplot` part tells sphinx **not** to build the examples
178+
in the [gallery](https://pytorch.org/vision/stable/auto_examples/index.html),
179+
which saves a lot of building time.
179180

180-
You can run ``make html-noplot`` to not build the examples at all. This is
181-
useful after a ``make clean`` to do some quick checks that are not related to
182-
the examples.
181+
If you need to build all the examples in the gallery, then you can use `make
182+
html`.
183183

184184
You can also choose to only build a subset of the examples by using the
185185
``EXAMPLES_PATTERN`` env variable, which accepts a regular expression. For

0 commit comments

Comments
 (0)