From b57cc41d93492af78876cb61f2d9b8a28a5902a4 Mon Sep 17 00:00:00 2001 From: Fabien Boucher Date: Tue, 17 Mar 2015 15:17:02 +0000 Subject: [PATCH] Complete the doc/README.rst instructions to build docs Give instructions about how to build the docs using tox and virtualenv. Change-Id: I3d7cdbd848158307706d94ee8a35b3b35911900d --- doc/README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/README.rst b/doc/README.rst index 835dbc5d9..02fc8eb54 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -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 ======================== -- 2.45.2