From 60b1041605f7bcb2b203858707621289858b79c7 Mon Sep 17 00:00:00 2001 From: Alon Zakai Date: Mon, 26 Feb 2024 13:18:41 -0800 Subject: [PATCH 1/4] [Docs] Document how to build and view the website locally [ci skip] --- docs/process.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/process.md b/docs/process.md index d4aa95f086adc..735e9492aab72 100644 --- a/docs/process.md +++ b/docs/process.md @@ -170,6 +170,18 @@ You will need the specific sphinx version installed, which you can do using need to add `~/.local/bin` to your path, if pip installs to there). +### Building and viewing the Website locally + +To build the site locally for testing purposes you only need a subset of the +`update_docs.py` command just mentioned above. Specifically: + +1. Run the `pip3` command from before and adjust your path (see above). +2. Go to `site/`. +3. Run `make html`. +4. Run a local webserver, like `python3 -m http.server`. +5. Browse to `http://localhost:8000/build/html/` (or another port as relevant). + + ## Updating the `emcc.py` help text `emcc --help` output is generated from the main documentation under `site/`, From 7ad802bd356b79d720f3f867aa3e0b165ed29789 Mon Sep 17 00:00:00 2001 From: Alon Zakai Date: Tue, 27 Feb 2024 10:42:06 -0800 Subject: [PATCH 2/4] fix --- docs/process.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/process.md b/docs/process.md index 735e9492aab72..870dac9b267e3 100644 --- a/docs/process.md +++ b/docs/process.md @@ -176,8 +176,7 @@ To build the site locally for testing purposes you only need a subset of the `update_docs.py` command just mentioned above. Specifically: 1. Run the `pip3` command from before and adjust your path (see above). -2. Go to `site/`. -3. Run `make html`. +2. Run `make -C site html`. 4. Run a local webserver, like `python3 -m http.server`. 5. Browse to `http://localhost:8000/build/html/` (or another port as relevant). From e09f649c7f84f38099d443bbd407435fe8da975a Mon Sep 17 00:00:00 2001 From: Alon Zakai Date: Tue, 27 Feb 2024 10:45:57 -0800 Subject: [PATCH 3/4] feedback --- docs/process.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/process.md b/docs/process.md index 870dac9b267e3..18a3455e0f8f6 100644 --- a/docs/process.md +++ b/docs/process.md @@ -175,10 +175,10 @@ need to add `~/.local/bin` to your path, if pip installs to there). To build the site locally for testing purposes you only need a subset of the `update_docs.py` command just mentioned above. Specifically: -1. Run the `pip3` command from before and adjust your path (see above). +1. Run `pip3` to install python dependencies, as described above. 2. Run `make -C site html`. -4. Run a local webserver, like `python3 -m http.server`. -5. Browse to `http://localhost:8000/build/html/` (or another port as relevant). +3. Run a local webserver, e.g. `python3 -m http.server 8000 -d site/build/html`. +4. Browse to `http://localhost:8000/` (adjust port as needed). ## Updating the `emcc.py` help text From 13820cf35fd92dad895e8975367609d7193ea3c1 Mon Sep 17 00:00:00 2001 From: Alon Zakai Date: Tue, 27 Feb 2024 10:46:56 -0800 Subject: [PATCH 4/4] feedback --- docs/process.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/process.md b/docs/process.md index 18a3455e0f8f6..0c3b23b1062d7 100644 --- a/docs/process.md +++ b/docs/process.md @@ -177,8 +177,9 @@ To build the site locally for testing purposes you only need a subset of the 1. Run `pip3` to install python dependencies, as described above. 2. Run `make -C site html`. -3. Run a local webserver, e.g. `python3 -m http.server 8000 -d site/build/html`. -4. Browse to `http://localhost:8000/` (adjust port as needed). +3. Run a local webserver on the outout of that command, e.g., + `python3 -m http.server 8000 -d site/build/html`. +4. Browse to `http://localhost:8000/` (assuming you use port 8000 as above). ## Updating the `emcc.py` help text