Skip to content

Commit 94b7b92

Browse files
committed
Script local hosting of ref docs
1 parent a31435d commit 94b7b92

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

doc/sphinx/README.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ To build the html content, do this:
77

88
1. Set working directory to the root of this repository.
99
2. Install sphinx into your venv: `pip install sphinx`
10-
3. Build the HTML: `(cd doc/sphinx && make html)`
11-
4. Serve the HTML: `(cd doc/sphinx/build/ && python -m http.server 8000)`
12-
5. Go to `localhost:8000` in your web browser.
10+
3. Run `./scripts/render_api_docs`
11+
4. Go to `localhost:8000` in your web browser.
1312
1413
In order to make changes, iterate on steps 3-5 above.
1514

scripts/render_api_docs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/usr/bin/env bash
2+
3+
cd doc/sphinx
4+
make clean html
5+
cd build/
6+
python3 -m http.server 8000

0 commit comments

Comments
 (0)