Skip to content

Commit

Permalink
Update docs README with addition on viewing docs locally (#3140)
Browse files Browse the repository at this point in the history
This PR adds instructions on launching a local python3 http server to
view freshly rebuilt docs.
  • Loading branch information
yadudoc authored Mar 5, 2024
1 parent 23a8c70 commit 204639a
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://localhost:8080>`_


Regenerate module stubs
--------------------------
Expand Down

0 comments on commit 204639a

Please sign in to comment.