From e3628363962297fbfd5da031542be12a7d0a0da3 Mon Sep 17 00:00:00 2001 From: Akilan Pughazhendi Date: Wed, 3 Aug 2016 17:32:22 +0000 Subject: [PATCH] Updated Dev quickstart for viewing doc changes The instructions for viewing doc changes were unclear so I updated them to be easier to follow Change-Id: I0cae488e4ee1d5690557cd5be608925467d370c0 --- doc/source/dev/dev-quickstart.rst | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/doc/source/dev/dev-quickstart.rst b/doc/source/dev/dev-quickstart.rst index 79fa7ece85..246bb11db5 100644 --- a/doc/source/dev/dev-quickstart.rst +++ b/doc/source/dev/dev-quickstart.rst @@ -659,7 +659,9 @@ Building developer documentation If you would like to build the documentation locally, eg. to test your documentation changes before uploading them for review, run these -commands to build the documentation set:: +commands to build the documentation set: + +- On your local machine:: # activate your development virtualenv source .tox/venv/bin/activate @@ -667,7 +669,26 @@ commands to build the documentation set:: # build the docs tox -edocs -Now use your browser to open the top-level index.html located at:: + #Now use your browser to open the top-level index.html located at: ironic/doc/build/html/index.html + +- On a remote machine:: + + # Go to the directory that contains the docs + cd ~/ironic/doc/source/ + + # Build the docs + tox -edocs + + # Change directory to the newly built HTML files + cd ~/ironic/doc/build/html/ + + # Create a server using python on port 8000 + python -m SimpleHTTPServer 8000 + + #Now use your browser to open the top-level index.html located at: + + http://your_ip:8000 +