From f8e4eab6844ce000d69324157e282b8f614513e2 Mon Sep 17 00:00:00 2001
From: Lucas Alvares Gomes <lucasagomes@gmail.com>
Date: Fri, 14 Nov 2014 17:14:19 +0000
Subject: [PATCH] Add gendocs tox job for generating the documentation

We already use tox to generate the sample configuration, run the tests,
etc.. This patch is adding a new 'gendocs' tox job for generating the
documentation. I always have a hard time remembering the syntax to
generate the docs, by adding it to tox I hope it may facilitate it a bit.

You can now (re)generate the docs with this tox job:

tox -egendocs

The quick start guide was also updated with the new command.

Change-Id: I6a755c31382310420d706e51a3e014941fd49872
---
 doc/source/dev/dev-quickstart.rst | 2 +-
 tox.ini                           | 6 ++++++
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/doc/source/dev/dev-quickstart.rst b/doc/source/dev/dev-quickstart.rst
index 5f235b6a07..2e84f3bec3 100644
--- a/doc/source/dev/dev-quickstart.rst
+++ b/doc/source/dev/dev-quickstart.rst
@@ -412,7 +412,7 @@ commands to build the documentation set::
     source .tox/venv/bin/activate
 
     # build the docs
-    python setup.py build_sphinx
+    tox -egendocs
 
 Now use your browser to open the top-level index.html located at::
 
diff --git a/tox.ini b/tox.ini
index 3064fc9545..888b4582f4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -40,6 +40,12 @@ envdir = {toxworkdir}/venv
 commands =
   bash tools/config/generate_sample.sh -b . -p ironic -o etc/ironic
 
+[testenv:gendocs]
+sitepackages = False
+envdir = {toxworkdir}/venv
+commands =
+  python setup.py build_sphinx
+
 [testenv:venv]
 setenv = PYTHONHASHSEED=0
 commands = {posargs}