Skip to content

Commit

Permalink
Small docs readme update (#14062)
Browse files Browse the repository at this point in the history
* Add instruction for running docs locally

* Fix RST syntax

* Update docs/README.rst

Co-authored-by: Kaxil Naik <[email protected]>

Co-authored-by: Kaxil Naik <[email protected]>
  • Loading branch information
leahecole and kaxil authored Feb 4, 2021
1 parent 5f74219 commit f6cfc41
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,17 @@ or just to run documentation building
.. code-block:: bash
./breeze build-docs -- --docs-only
Running the Docs Locally
------------------------

Once you have built the documentation run the following command from the root directory:

.. code-block:: bash
docs/start_doc_server.sh
Then, view your docs at ``localhost:8000``

Troubleshooting
---------------
Expand Down

0 comments on commit f6cfc41

Please sign in to comment.