Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
vision
Commits
7d83be5e
Unverified
Commit
7d83be5e
authored
Apr 21, 2022
by
Nicolas Hug
Committed by
GitHub
Apr 21, 2022
Browse files
Document make html-noplot as the default doc building method (#5847)
parent
35d1d9d3
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
7 deletions
+7
-7
CONTRIBUTING.md
CONTRIBUTING.md
+7
-7
No files found.
CONTRIBUTING.md
View file @
7d83be5e
...
@@ -159,7 +159,7 @@ pip install -r requirements.txt
...
@@ -159,7 +159,7 @@ pip install -r requirements.txt
```
bash
```
bash
cd
docs
cd
docs
make html
make html
-noplot
```
```
Then open
`docs/build/html/index.html`
in your favorite browser.
Then open
`docs/build/html/index.html`
in your favorite browser.
...
@@ -173,13 +173,13 @@ clean``.
...
@@ -173,13 +173,13 @@ clean``.
#### Building the example gallery - or not
#### Building the example gallery - or not
When you run
``make html``
for the first time, all the examples in the gallery
In most cases, running
`make html-noplot`
is enough to build the docs for your
will be built. Subsequent builds should be faster, and will only build the
specific use-case. The
`noplot`
part tells sphinx
**not**
to build the examples
examples that have been modified.
in the
[
gallery
](
https://pytorch.org/vision/stable/auto_examples/index.html
)
,
which saves a lot of building time.
You can run
``make html-noplot``
to not build the examples at all. This is
If you need to build all the examples in the gallery, then you can use
`make
useful after a
``make clean``
to do some quick checks that are not related to
html`
.
the examples.
You can also choose to only build a subset of the examples by using the
You can also choose to only build a subset of the examples by using the
``EXAMPLES_PATTERN``
env variable, which accepts a regular expression. For
``EXAMPLES_PATTERN``
env variable, which accepts a regular expression. For
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment