From 204639af4605d45e86b3fb06353679a8fe5e9068 Mon Sep 17 00:00:00 2001 From: Yadu Nand Babuji Date: Tue, 5 Mar 2024 11:45:39 -0600 Subject: [PATCH] Update docs README with addition on viewing docs locally (#3140) This PR adds instructions on launching a local python3 http server to view freshly rebuilt docs. --- docs/README.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/README.rst b/docs/README.rst index 44f91eb16f..f50c03f3d1 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -21,7 +21,15 @@ Local builds To build the documentation locally, use:: - $ make html + $ make clean html + +To view the freshly rebuilt docs, use:: + + $ cd _build/html + $ python3 -m http.server 8080 + +Once the python http server is launched, point your browser to `http://localhost:8080 `_ + Regenerate module stubs --------------------------