Skip to content

Commit 7dbbbaa

Browse files
authored
[Docs] Document how to build and view the website locally (#21434)
1 parent a3b9509 commit 7dbbbaa

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/process.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,18 @@ You will need the specific sphinx version installed, which you can do using
170170
need to add `~/.local/bin` to your path, if pip installs to there).
171171

172172

173+
### Building and viewing the Website locally
174+
175+
To build the site locally for testing purposes you only need a subset of the
176+
`update_docs.py` command just mentioned above. Specifically:
177+
178+
1. Run `pip3` to install python dependencies, as described above.
179+
2. Run `make -C site html`.
180+
3. Run a local webserver on the outout of that command, e.g.,
181+
`python3 -m http.server 8000 -d site/build/html`.
182+
4. Browse to `http://localhost:8000/` (assuming you use port 8000 as above).
183+
184+
173185
## Updating the `emcc.py` help text
174186

175187
`emcc --help` output is generated from the main documentation under `site/`,

0 commit comments

Comments
 (0)