Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Small docs readme update #14062

Merged
merged 3 commits into from
Feb 4, 2021
Merged

Small docs readme update #14062

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edb748d
Add instruction for running docs locally
leahecole Feb 4, 2021
ae73cca
Fix RST syntax
leahecole Feb 4, 2021
e403003
Update docs/README.rst
leahecole Feb 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/README.rst
View file
Open in desktop
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
leahecole marked this conversation as resolved.
Show resolved Hide resolved

Then, view your docs at ``localhost:8000``

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