[docs] Add plugin reference

This patch adds single page that contains
list of all plugins with their description.

In the future next things will be addressed:

- Split this page into few pages, each page should
  contain only specific type of plugins

- Improve descriptions of plugins that we have,
  especially description of context classes

- Add description to base plugin classes that expalins
  how everything works.
  So it won't be hardcoded in plugins.rst and it will
  be possilbe to use it in different places

Change-Id: I87ec6f8497392306578d91263c98c4c035acc521

doc/ext/plugin_reference.py

@@ -0,0 +1,156 @@
+# Copyright 2015: Mirantis Inc.
+# All Rights Reserved.
+#
+#    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.
+
+from docutils import nodes
+from docutils.parsers import rst
+
+from oslo_utils import importutils
+
+from rally import plugins
+
+DATA = [
+    {
+        "group": "Task plugins",
+        "items": [
+            {
+                "name": "Scenario Runners",
+                "base": "rally.task.runner:ScenarioRunner"
+            },
+            {
+                "name": "SLAs",
+                "base": "rally.task.sla:SLA"
+            },
+            {
+                "name": "Contexts",
+                "base": "rally.task.context:Context"
+            },
+            {
+                "name": "Scenarios",
+                "base": "rally.task.scenario:Scenario"
+            }
+        ]
+    },
+    {
+        "group": "Deployment plugins",
+        "items": [
+            {
+                "name": "Engines",
+                "base": "rally.deployment.engine:Engine"
+            },
+            {
+                "name": "ProviderFactory",
+                "base":
+                "rally.deployment.serverprovider.provider:ProviderFactory"
+            }
+        ]
+    }
+]
+
+
+def make_row(data):
+    row = nodes.row()
+    for item in data:
+        node_type, text = item
+        entry = nodes.entry()
+        entry.append(node_type(text=text))
+        row.append(entry)
+
+    return row
+
+
+def make_table(data):
+    table = nodes.table()
+    table_group = nodes.tgroup()
+
+    for w in data["colwidth"]:
+        table_group.append(nodes.colspec(colwidth=w))
+
+    table_head = nodes.thead()
+    table_head.append(make_row(data["headers"]))
+    table_group.append(table_head)
+
+    table_body = nodes.tbody()
+    for row in data["rows"]:
+        table_body.append(make_row(row))
+    table_group.append(table_body)
+
+    table.append(table_group)
+
+    return table
+
+
+def _make_pretty_parameters(parameters):
+    if not parameters:
+        return ""
+
+    result = "PARAMETERS:\n"
+    for p in parameters:
+        result += "* %(name)s: %(doc)s\n" % p
+    return result
+
+
+def _get_plugin_info(plugin_group_item):
+    module, cls = plugin_group_item["base"].split(":")
+    plugin_base = getattr(importutils.import_module(module), cls)
+
+    def process_plugin(p):
+        info = p.get_info()
+
+        description = [info["title"] or ""]
+        if info["description"]:
+            description.append(info["description"])
+        if info["parameters"]:
+            description.append(_make_pretty_parameters(info["parameters"]))
+        if info["returns"]:
+            description.append("RETURNS:\n%s" % info["returns"])
+        description.append("MODULE:\n%s" % info["module"])
+
+        return [
+            [nodes.inline, p.get_name()],
+            [nodes.doctest_block, "\n\n".join(description)]
+        ]
+
+    return {
+        "headers": zip([nodes.inline] * 2,
+                       ["name", "description"]),
+        "colwidth": [1, 1],
+        "rows": map(process_plugin, plugin_base.get_all())
+    }
+
+
+def make_plugin_section(plugin_group):
+    elements = []
+
+    for item in plugin_group["items"]:
+        elements.append(nodes.rubric(text=item["name"]))
+        elements.append(make_table(_get_plugin_info(item)))
+
+    return elements
+
+
+class PluginReferenceDirective(rst.Directive):
+
+    def run(self):
+        content = []
+        for i in range(len(DATA)):
+            content.append(nodes.subtitle(text=DATA[i]["group"]))
+            content.extend(make_plugin_section(DATA[i]))
+
+        return content
+
+
+def setup(app):
+    plugins.load()
+    app.add_directive('generate_plugin_reference', PluginReferenceDirective)

doc/source/conf.py

@@ -3,10 +3,10 @@
 # Rally documentation build configuration file, created by
 # sphinx-quickstart on Fri Jan 10 23:19:18 2014.
 #
-# This file is execfile()d with the current directory set to its containing dir.
+# This file is execfile() with the current directory set to its containing dir.
 #
 # Note that not all possible configuration values are present in this
-# autogenerated file.
+# auto-generated file.
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
@@ -18,18 +18,25 @@ import sys
 # 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.
-sys.path.extend([
+#sys.path.extend([
-    os.path.abspath("../.."),
+#    os.path.abspath("../.."),
-])
+#    os.path.abspath("../"),
+#    os.path.abspath("./")
+#])
+
+sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('./'))
 
 
-# -- General configuration -----------------------------------------------------
+# -- General configuration ----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = "1.0"
+# needs_sphinx = "1.0"
 
-# Add any Sphinx extension module names here, as strings. They can be extensions
+# Add any Sphinx extension module names here, as strings.
-# coming with Sphinx (named "sphinx.ext.*") or your custom ones.
+# They can be extensions coming with Sphinx (named "sphinx.ext.*") or your
+# custom ones.
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
@@ -37,6 +44,7 @@ extensions = [
     "sphinx.ext.coverage",
     "sphinx.ext.ifconfig",
     "sphinx.ext.viewcode",
+    "ext.plugin_reference"
 ]
 todo_include_todos = True
 
@@ -47,7 +55,7 @@ templates_path = ["_templates"]
 source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = "utf-8-sig"
+# source_encoding = "utf-8-sig"
 
 # The master toctree document.
 master_doc = "index"
@@ -67,21 +75,24 @@ release = "0.0.4"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ""
+# today = ""
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = "%B %d, %Y"
+# today_fmt = "%B %d, %Y"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["feature_request/README.rst", "samples/README.rst",
+exclude_patterns = [
-                    "**/README.rst"]
+    "feature_request/README.rst",
+    "samples/README.rst",
+    "**/README.rst"
+]
 
-# The reST default role (used for this markup: `text`) to use for all documents.
+# The reST default role (used for this markup: `text`) to use for all documents
-#default_role = None
+# default_role = None
 
 # If true, "()" will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -92,16 +103,16 @@ add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output --------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
@@ -110,26 +121,26 @@ html_theme = "default"
 # 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 = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # 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,
@@ -143,46 +154,46 @@ html_last_updated_fmt = os.popen(git_cmd).read()
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ""
+# html_use_opensearch = ""
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = "%sdoc" % project
 
 
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output -------------------------------------------------
 
 latex_elements = {
 # The paper size ("letterpaper" or "a4paper").
@@ -196,7 +207,7 @@ latex_elements = {
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
+# (source start file, target name, title, author, documentclass [howto/manual])
 latex_documents = [
     ("index",
      "%s.tex" % project,
@@ -206,54 +217,54 @@ latex_documents = [
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
-# -- Options for manual page output --------------------------------------------
+# -- Options for manual page output -------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-#man_pages = [
+# man_pages = [
 #    ("index", "rally", u"Rally Documentation",
 #     [u"Rally Team"], 1)
-#]
+# ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
-# -- Options for Texinfo output ------------------------------------------------
+# -- 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 = [
   ("index", "Rally", u"Rally Documentation",
-   u"Rally Team", "Rally", "One line description of project.",
+   u"Rally Team", "Rally", "Testing framework and tool for all kinds of tests",
-   "Miscellaneous"),
+   "Development"),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: "footnote", "no", or "inline".
-#texinfo_show_urls = "footnote"
+# texinfo_show_urls = "footnote"

doc/source/contribute.rst

@@ -13,8 +13,6 @@
       License for the specific language governing permissions and limitations
       under the License.
 
-
-
 .. _contribute:
 
 Contribute to Rally

doc/source/index.rst

@@ -32,6 +32,7 @@ Contents
    tutorial
    user_stories
    plugins
+   plugin/plugin_reference
    contribute
    gates
    feature_requests