Update test files for openstack-infra

* also update the gitreview file
* add base doc folder for future use (and to make
  CI happy)

Change-Id: Ifd854682c8121720e940c0a7d8ac3656cbf97af0

.gitignore

@@ -5,5 +5,6 @@
 .coverage
 python_adjutant.egg-info/*
 dist/*
+build/
 .tox/*
 env/*

.gitreview

@@ -1,5 +1,4 @@
 [gerrit]
-host=gerrit.dmz.wgtn.cat-it.co.nz
+host=review.openstack.org
 port=29418
-project=openstack-registration.git
+project=openstack/adjuntant.git
-defaultbranch=master

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = Adjutant
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/source/conf.py

@@ -0,0 +1,137 @@
+# -*- coding: utf-8 -*-
+#
+# Adjutant documentation build configuration file, created by
+# sphinx-quickstart on Wed Jun 21 13:29:33 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Adjutant'
+copyright = u'2017, Catalyst IT Ltd'
+
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# 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
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Adjutantdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Adjutant.tex', u'Adjutant Documentation',
+     u'Catalyst IT Ltd', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'adjutant', u'Adjutant Documentation',
+     ['Catalyst IT Ltd'], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Adjutant', u'Adjutant Documentation',
+     'Catalyst IT Ltd', 'Adjutant', 'One line description of project.',
+     'Miscellaneous'),
+]

doc/source/index.rst

@@ -0,0 +1,20 @@
+.. Adjutant documentation master file, created by
+   sphinx-quickstart on Wed Jun 21 13:29:33 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Adjutant's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

setup.py

@@ -27,6 +27,13 @@ setup(
         'Environment :: OpenStack',
     ],
 
+    command_options={
+        'build_sphinx': {
+            'build_dir': ('setup.py', 'doc/build'),
+            'source_dir': ('setup.py', 'doc/source'),
+        }
+    },
+
     keywords='openstack keystone users tasks registration workflow',
     packages=find_packages(),
     package_data={

test-requirements.txt

@@ -1,3 +1,4 @@
 mock==1.2.0
 flake8>=3.0.4
 coverage>=4.4.1
+sphinx!=1.6.1,>=1.5.1

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py35,pep8,coverage
+envlist = py27,py35,pep8,cover
 skipsdist = True
 
 [testenv]
@@ -12,12 +12,18 @@ setenv = VIRTUAL_ENV={envdir}
 [testenv:pep8]
 commands = flake8
 
-[testenv:coverage]
+[testenv:cover]
 commands =
-    coverage run --source='.' .tox/coverage/bin/adjutant-api test {posargs}
+    coverage run --source='.' .tox/cover/bin/adjutant-api test {posargs}
     coverage report --include adjutant/* -m
 basepython = python2.7
 
+[testenv:venv]
+commands = {posargs}
+
+[testenv:docs]
+commands = python setup.py build_sphinx
+
 [flake8]
 ignore = D100,D101,D102,D103,D104,D105,D200,D203,D202,D204,D205,D208,D400,D401
 show-source = true