openstack/cinder
Code Issues Proposed changes

Complete the doc/README.rst instructions to build docs

Browse Source 
Give instructions about how to build the docs using tox
and virtualenv.

Change-Id: I3d7cdbd848158307706d94ee8a35b3b35911900d
This commit is contained in:
Fabien Boucher 2015-03-17 15:17:02 +00:00
parent e7fdd10da6
commit b57cc41d93
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/README.rst
View File

@ -49,6 +49,17 @@ Manually
% sphinx-build -b html source build/html % sphinx-build -b html source build/html
Use `tox`
=========
The easiest way to build the docs and avoid dealing with all
dependencies is to let tox prepare a virtualenv and run the
build_sphinx target inside the virtualenv::
% cd ..
% tox -e docs
The docs have been built The docs have been built
======================== ========================