Skip to content

Commit 69946a0

Browse files
authored
Use correct make rules for building docs in devguide (#4180)
1 parent 11212e6 commit 69946a0

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

site-src/contributing/devguide.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -141,21 +141,19 @@ manually preview docs changes locally, you can install mkdocs and run:
141141
make docs
142142
```
143143

144-
To make it easier to use the right version of mkdocs, there is a `.venv`
145-
target to create a Python virtualenv that includes mkdocs. To use the
146-
mkdocs live preview server while you edit, you can run mkdocs from
147-
the virtualenv:
144+
To make it easier to use the right version of mkdocs, you can build and serve the docs in a container:
148145

149146
```shell
150-
$ make .venv
151-
Creating a virtualenv in .venv... OK
152-
To enter the virtualenv type "source .venv/bin/activate", to exit type "deactivate"
153-
(.venv) $ source .venv/bin/activate
154-
(.venv) $ mkdocs serve
155-
INFO - Building documentation...
147+
$ make build-docs
156148
...
149+
INFO - Documentation built in 6.73 seconds
150+
$ make live-docs
151+
...
152+
INFO - [15:16:59] Serving on http://0.0.0.0:3000/
157153
```
158154

155+
You can then view the docs at http://localhost:3000/.
156+
159157
For more information on how documentation should be written, refer to our
160158
[Documentation Style Guide](style-guide.md).
161159

0 commit comments

Comments
 (0)