Skip to content

Commit 1015bd4

Browse files
committed
Update setup-build.md with correct instructions and descriptions of commands
1 parent 22f72e1 commit 1015bd4

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

docs/contributing/setup-build.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ brew install enchant
3131
sudo apt-get install enchant
3232
```
3333

34-
Clone the Plone Documentation repository, then create a Python virtual environment, install project dependencies, and activate the virtual environment.
34+
Clone the Plone Documentation repository, and change your working directory into the cloned project.
35+
Then with a single command using `Makefile`, create a Python virtual environment, install project dependencies, pull in Volto documentation as a git submodule, build the docs, and view the results in a web browser by opening `/_build/html/index.html`.
3536

3637
```shell
3738
git clone https://github.com/plone/documentation.git
3839
cd documentation
39-
make build
40-
source bin/activate
40+
make html
4141
```
4242

4343

@@ -47,16 +47,18 @@ source bin/activate
4747

4848
All build and check documentation commands use the file `Makefile`.
4949

50-
To see all available builds:
50+
To see the most frequently used builds, use the following command.
5151

5252
```shell
53-
make
53+
make help
5454
```
5555

56+
Else you can open `Makefile` to see other build formats, including PDF.
57+
5658

5759
### `html`
5860

59-
`html` is the long narrative version used for the online documentation and by the trainer.
61+
`html` is the HTML version of the documentation.
6062

6163
```shell
6264
make html
@@ -65,6 +67,17 @@ make html
6567
Open `/_build/html/index.html` in a web browser.
6668

6769

70+
### `livehtml`
71+
72+
`livehtml` rebuilds Sphinx documentation on changes, with live-reload in the browser.
73+
74+
```shell
75+
make livehtml
76+
```
77+
78+
Open http://0.0.0.0:8000/ in a web browser.
79+
80+
6881
### `linkcheck`
6982

7083
`linkcheck` checks all links.

0 commit comments

Comments
 (0)