Initial Cookiecutter commit
Change-Id: Iceff2531f4f7de21dcbb91ee893a8205b6c85107
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100755
index 0000000..d75a939
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,75 @@
+# -*- 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',
+ #'sphinx.ext.intersphinx',
+ 'oslosphinx'
+]
+
+# 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'patrole'
+copyright = u'2016, 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}
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
new file mode 100644
index 0000000..1728a61
--- /dev/null
+++ b/doc/source/contributing.rst
@@ -0,0 +1,4 @@
+============
+Contributing
+============
+.. include:: ../../CONTRIBUTING.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..fbe592c
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,25 @@
+.. patrole documentation master file, created by
+ sphinx-quickstart on Tue Jul 9 22:26:36 2013.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to patrole's documentation!
+========================================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ readme
+ installation
+ usage
+ contributing
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
new file mode 100644
index 0000000..51b0645
--- /dev/null
+++ b/doc/source/installation.rst
@@ -0,0 +1,48 @@
+============
+Installation
+============
+
+Installation Information
+########################
+
+At the command line::
+
+ $ pip install patrole
+
+Or, if you have virtualenvwrapper installed::
+
+ $ mkvirtualenv patrole
+ $ pip install patrole
+
+Configuration Information
+#########################
+
+tempest.conf
+++++++++++++
+
+To run the RBAC tempest api test you have to make the following changes to
+the tempest.conf file.
+
+#. [auth] section updates ::
+
+ # Set tempest role to admin so all APIs are accessible
+ tempest_roles = admin
+
+ # Allows test cases to create/destroy tenants and users. This
+ # option enables isolated test cases and better parallel
+ # execution, but also requires that OpenStack Identity API
+ # admin credentials are known. (boolean value)
+ allow_tenant_isolation = True
+
+ # Allows test cases to create/destroy projects and users. This option
+ # requires that OpenStack Identity API admin credentials are known. If
+ # false, isolated test cases and parallel execution, can still be
+ # achieved configuring a list of test accounts (boolean value)
+ use_dynamic_credentials = False
+
+#. [rbac] section updates ::
+
+ # The role that you want the RBAC tests to use for RBAC testing
+ rbac_role=_member_
+ # Tell standard RBAC test cases to run other wise it they are skipped.
+ rbac_flag=true
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
new file mode 100644
index 0000000..a6210d3
--- /dev/null
+++ b/doc/source/readme.rst
@@ -0,0 +1 @@
+.. include:: ../../README.rst
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
new file mode 100644
index 0000000..5d6c0b9
--- /dev/null
+++ b/doc/source/usage.rst
@@ -0,0 +1,10 @@
+========
+Usage
+========
+
+To use run patrole tests in Tempest::
+
+ If patrole is installed correctly tests are run like any others.
+
+ To change the role that the patrole tests are being run as edit rbac_role
+ in the rbac section of tempest.conf.