Initial support for sphinxdoc

This is the first patch in a series to convert tripleo-quickstart to
using sphinx for documentation. This bring the project more inline
with existing OpenStack tooling.

Change-Id: I84c2d8c91d2b1c7efb91fdd857ae985a1b2c6c62
Signed-off-by: Paul Belanger <pabelanger@redhat.com>

.gitignore

@@ -49,7 +49,7 @@ coverage.xml
 *.log
 
 # Sphinx documentation
-docs/_build/
+doc/build/
 
 # PyBuilder
 target/

README.rst

@@ -1,4 +1,5 @@
-# tripleo-quickstart
+tripleo-quickstart
+==================
 
 One of the barriers to entry for trying out TripleO and its derivatives
 has been the relative difficulty in getting an environment up quickly.
@@ -19,7 +20,8 @@ A quick way to test that your virthost machine is ready to rock is:
 The defaults are meant to "just work", so it is as easy as downloading
 and running the quickstart.sh script.
 
-## Getting the script
+Getting the script
+------------------
 
 You can download the `quickstart.sh` script with `wget`:
 
@@ -28,14 +30,16 @@ You can download the `quickstart.sh` script with `wget`:
 Alternatively, you can clone this repository and run the script from
 there.
 
-## Requirements
+Requirements
+------------
 
 You need some software available on your local system before you can run
 `quickstart.sh`. You can install the necessary dependencies by running:
 
     bash quickstart.sh --install-deps
 
-## Deploying with instructions
+Deploying with instructions
+---------------------------
 
 Deploy your virtual environment by running:
 
@@ -51,7 +55,8 @@ recreate it.
 This script will output instructions at the end to access the deployed
 undercloud. If a release name is not given, `mitaka` is used.
 
-## Deploying without instructions
+Deploying without instructions
+------------------------------
 
     bash quickstart.sh --tags all $VIRTHOST
 
@@ -61,7 +66,8 @@ flag will instruct quickstart to provision the environment and deploy
 both the undercloud and overcloud.  Additionally a validation test will
 be executed to ensure the overcloud is functional.
 
-## Deploying on localhost
+Deploying on localhost
+----------------------
 
     bash quickstart.sh localhost
 
@@ -72,7 +78,8 @@ e.g. ~/.quickstart/ssh.config.ansible will try to proxy through the localhost to
 to the localhost and will cause an error if ssh is not setup to support it.  An alternative
 workflow is being tested and can be found under tripleo-quickstart/ci-scripts/usbkey/.
 
-## Enable Developer mode
+Enable Developer mode
+---------------------
 
 If you are working on TripleO upstream development, and need to reproduce
 what runs in tripleo-ci, you will want to use developer mode.
@@ -86,11 +93,13 @@ developer mode would be:
             --release master-tripleo \
             $VIRTHOST
 
-## Documentation
+Documentation
+-------------
 
 Additional documentation is available in the [docs/](docs/) directory.
 
-## Copyright
+Copyright
+---------
 
 Copyright 2015-2016 Red Hat, Inc.
 

doc/source/conf.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+# 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.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'tripleo-quickstart'
+copyright = u'2013, OpenStack Foundation'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     u'%s Documentation' % project,
+     u'OpenStack Foundation', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+# intersphinx_mapping = {'http://docs.python.org/': None}

doc/source/index.rst

@@ -0,0 +1 @@
+.. include:: ../../README.rst

setup.cfg

@@ -2,7 +2,7 @@
 name = tripleo-quickstart
 summary = tripleo-quickstart - Making it easy to get started with tripleo
 description-file =
-    README.md
+    README.rst
 author = John Trowbridge
 author-email = jtrowbri@redhat.com
 home-page = https://github.com/openstack/tripleo-quickstart
@@ -14,6 +14,11 @@ classifier =
   Intended Audience :: Information Technology
   Topic :: Utilities
 
+[build_sphinx]
+all_files = 1
+build-dir = doc/build
+source-dir = doc/source
+
 [global]
 setup-hooks =
     pbr.hooks.setup_hook

test-requirements.txt

@@ -2,3 +2,4 @@ hacking<0.11,>=0.10
 
 ansible-lint
 jenkins-job-builder
+sphinx>=1.2.1,!=1.3b1,<1.3  # BSD

tox.ini

@@ -12,6 +12,9 @@ deps = -r{toxinidir}/test-requirements.txt
 [testenv:jjb]
 commands = jenkins-jobs test {toxinidir}/jenkins/jobs
 
+[testenv:docs]
+commands = python setup.py build_sphinx
+
 [testenv:linters]
 whitelist_externals = bash
 commands =