diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/cli.rst | 18 | ||||
| -rwxr-xr-x | doc/source/conf.py | 75 | ||||
| -rw-r--r-- | doc/source/contributing.rst | 4 | ||||
| -rw-r--r-- | doc/source/decorators.rst | 13 | ||||
| -rw-r--r-- | doc/source/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 28 | ||||
| -rw-r--r-- | doc/source/installation.rst | 12 | ||||
| -rw-r--r-- | doc/source/readme.rst | 1 | ||||
| -rw-r--r-- | doc/source/rest_client.rst | 11 | ||||
| -rw-r--r-- | doc/source/usage.rst | 24 | ||||
| -rw-r--r-- | doc/source/utils.rst | 11 |
11 files changed, 0 insertions, 198 deletions
diff --git a/doc/source/cli.rst b/doc/source/cli.rst deleted file mode 100644 index 301510e..0000000 --- a/doc/source/cli.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _cli: - -CLI Testing Framework Usage -=========================== - -------------------- -The cli.base module -------------------- - -.. automodule:: tempest_lib.cli.base - :members: - ----------------------------- -The cli.output_parser module ----------------------------- - -.. automodule:: tempest_lib.cli.output_parser - :members: diff --git a/doc/source/conf.py b/doc/source/conf.py deleted file mode 100755 index 4aff3f2..0000000 --- a/doc/source/conf.py +++ /dev/null @@ -1,75 +0,0 @@ -# -*- 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'tempest-lib' -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}
\ No newline at end of file diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index ed77c12..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file diff --git a/doc/source/decorators.rst b/doc/source/decorators.rst deleted file mode 100644 index a0b7c78..0000000 --- a/doc/source/decorators.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _decorators: - -Decorators Usage Guide -====================== - ---------------------- -The decorators module ---------------------- - -.. automodule:: tempest_lib.decorators - :members: - - diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst deleted file mode 100644 index 61f8c13..0000000 --- a/doc/source/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. tempest-lib 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 tempest-lib's documentation! -======================================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - readme - installation - usage - contributing - cli - decorators - history - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/doc/source/installation.rst b/doc/source/installation.rst deleted file mode 100644 index a0e6237..0000000 --- a/doc/source/installation.rst +++ /dev/null @@ -1,12 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ pip install tempest-lib - -Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv tempest-lib - $ pip install tempest-lib
\ No newline at end of file diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 38ba804..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst
\ No newline at end of file diff --git a/doc/source/rest_client.rst b/doc/source/rest_client.rst deleted file mode 100644 index 513d8e4..0000000 --- a/doc/source/rest_client.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _rest_client: - -Rest Client Usage -================= - ----------------------- -The rest_client module ----------------------- - -.. automodule:: tempest_lib.common.rest_client - :members: diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index e305244..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,24 +0,0 @@ -======== -Usage -======== - -To use tempest-lib in a project:: - - import tempest_lib - -:ref:`cli` ----------- -The CLI testing framework allows you to test the command line interface for -an OpenStack project's python-*client - - -:ref:`decorators` ------------------ -These decorators enable common utility functions inside of your test suite - - -:ref:`rest_client` ------------------- -The base building block for making a project specific client - - diff --git a/doc/source/utils.rst b/doc/source/utils.rst deleted file mode 100644 index 0e481b2..0000000 --- a/doc/source/utils.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _utils: - -Utils Usage -=========== - ---------------- -The misc module ---------------- - -.. automodule:: tempest_lib.common.utils.misc - :members: |