Uses tox for automating documentation builds

This patch adds the tox configuration required in order to automate
document builds and complete a docs gate check.

This patch adds the ceilometer link in configure.rst to get rid of
the warning message saying that nothing is actually linking to the
document, thereby failing the docs gate check.

Closes-Bug: #1469870
(cherry picked from commit 0ec3ce3d31
 and commit ed6ebcca03)
Change-Id: I8012889aa6938378b5e5e85fb443cf13be460d61

.gitignore

@@ -48,7 +48,13 @@ doc/build/
 Icon?
 ehthumbs.db
 Thumbs.db
+.eggs
 
 # User driven backup files #
 ############################
 *.bak
+
+# Generated by pbr while building docs
+######################################
+AUTHORS
+ChangeLog

dev-requirements.txt

@@ -4,5 +4,5 @@ hacking>=0.10.0,<0.11
 pep8==1.5.7
 pyflakes==0.8.1
 mccabe==0.2.1 # capped for flake8
-Sphinx==1.3.1
-oslosphinx>=3.0.0 # added for doc template
+sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
+oslosphinx>=2.5.0 # Apache-2.0

doc/source/conf.py

@@ -108,7 +108,7 @@ todo_include_todos = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+# html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

doc/source/install-guide/configure.rst

@@ -14,6 +14,7 @@ Chapter 5. Deployment configuration
    configure-cinder.rst
    configure-swift.rst
    configure-haproxy.rst
+   configure-ceilometer.rst
 
 
 **Figure 5.1. Installation work flow**

setup.cfg

@@ -0,0 +1,24 @@
+[metadata]
+name = os-ansible-deployment
+summary = Ansible playbooks for deploying OpenStack
+description-file =
+    README.rst
+author = OpenStack
+author-email = openstack-dev@lists.openstack.org
+home-page = http://www.openstack.org/
+classifier =
+    Intended Audience :: Developers
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: Apache Software License
+    Operating System :: POSIX :: Linux
+
+[build_sphinx]
+all_files = 1
+build-dir = doc/build
+source-dir = doc/source
+
+[pbr]
+warnerrors = True
+
+[wheel]
+universal = 1

setup.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
+import setuptools
+
+setuptools.setup(
+    setup_requires=['pbr'],
+    pbr=True)

tox.ini

@@ -0,0 +1,19 @@
+[tox]
+minversion = 1.6
+skipsdist = True
+envlist = docs
+
+[testenv]
+usedevelop = True
+install_command = pip install -U {opts} {packages}
+setenv = VIRTUAL_ENV={envdir}
+
+[testenv:docs]
+deps = -r{toxinidir}/dev-requirements.txt
+commands=
+    python setup.py build_sphinx
+
+# environment used by the -infra templated docs job
+[testenv:venv]
+deps = -r{toxinidir}/dev-requirements.txt
+commands = {posargs}