Skip to content

Commit 7f19ba7

Browse files
committed
DOC update instructions in doc/README - again
1 parent 117b1a7 commit 7f19ba7

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

doc/README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,27 @@ sphinx
88
sphinx_gallery
99
```
1010

11-
## Build the website
11+
## Build commands
1212

1313
```bash
14-
make html
15-
firefox _build/html/index.html
14+
make clean # Remove all files generated by the website build
15+
make html # Build the website, running all the examples (slow)
16+
make html-noplot # Build the website, without running all the examples (fast)
17+
make notebooks # Update the notebooks directory, *after* building the website
18+
19+
firefox _build/html/index.html # Open the built website
1620
```
1721

18-
## Update notebooks
22+
## Typical full build (slow)
1923

2024
```bash
21-
make html-noplot
22-
make notebooks
25+
make html
26+
firefox _build/html/index.html
2327
```
2428

25-
## Remove all files generated by the website build
29+
## Update notebooks (fast)
2630

2731
```bash
28-
make clean
32+
make html-noplot
33+
make notebooks
2934
```

0 commit comments

Comments
 (0)