openstack/ironic
Code Issues Proposed changes

Updated Dev quickstart for viewing doc changes

Browse Source 
The instructions for viewing doc changes were unclear so I
updated them to be easier to follow

Change-Id: I0cae488e4ee1d5690557cd5be608925467d370c0
This commit is contained in:
Akilan Pughazhendi 2016-08-03 17:32:22 +00:00
parent 4bd6e9793d
commit e362836396
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/source/dev/dev-quickstart.rst
View File

@ -659,7 +659,9 @@ Building developer documentation
If you would like to build the documentation locally, eg. to test your If you would like to build the documentation locally, eg. to test your
documentation changes before uploading them for review, run these 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 # activate your development virtualenv
source .tox/venv/bin/activate source .tox/venv/bin/activate
@ -667,7 +669,26 @@ commands to build the documentation set::
# build the docs # build the docs
tox -edocs 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 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