]> review.fuel-infra Code Review - openstack-build/cinder-build.git/commitdiff
Complete the doc/README.rst instructions to build docs
authorFabien Boucher <fabien.boucher@enovance.com>
Tue, 17 Mar 2015 15:17:02 +0000 (15:17 +0000)
committerFabien Boucher <fabien.boucher@enovance.com>
Thu, 16 Apr 2015 08:13:04 +0000 (08:13 +0000)
Give instructions about how to build the docs using tox
and virtualenv.

Change-Id: I3d7cdbd848158307706d94ee8a35b3b35911900d

doc/README.rst

index 835dbc5d9f6801b61fdef0b8c385bd759eadbcb8..02fc8eb54d55ef641674ec3f1d2f375931a2d374 100644 (file)
@@ -49,6 +49,17 @@ Manually
       % 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
 ========================