Fix Warnings generated while building of HTML docu

Same ID have been set to reference different RST blocks.
To avoid this, I added the prefix 'archi_' within ID referencing
architecture RST block.

Bad indentation warnings have been fixed.

Change-Id: I17f43f2f564ffd83fd5c345aed96fad06ee56b1d
Partial-Bug: #1522034

doc/source/architecture.rst

@@ -51,7 +51,7 @@ MongoDB,...) but will probably be more performant when using
 which are optimized for handling time series data, which are arrays of numbers
 indexed by time (a datetime or a datetime range).
 
-.. _watcher_api_definition:
+.. _archi_watcher_api_definition:
 
 Watcher API
 -----------
@@ -63,13 +63,13 @@ It enables the :ref:`Administrator <administrator_definition>` of a
 :ref:`Cluster <cluster_definition>` to control and monitor the Watcher system
 via any interaction mechanism connected to this API:
 
--   :ref:`CLI <watcher_cli_definition>`
+-   :ref:`CLI <archi_watcher_cli_definition>`
 -   Horizon plugin
 -   Python SDK
 
 You can also read the detailed description of `Watcher API`_.
 
-.. _watcher_applier_definition:
+.. _archi_watcher_applier_definition:
 
 Watcher Applier
 ---------------
@@ -111,7 +111,7 @@ If the :ref:`Action <action_definition>` fails, the
 previous state of the :ref:`Managed resource <managed_resource_definition>`
 (i.e. before the command was sent to the underlying OpenStack service).
 
-.. _watcher_cli_definition:
+.. _archi_watcher_cli_definition:
 
 Watcher CLI
 -----------
@@ -121,14 +121,14 @@ Watcher system in order to control it or to know its current status.
 
 Please, read `the detailed documentation about Watcher CLI <https://factory.b-com.com/www/watcher/doc/python-watcherclient/>`_
 
-.. _watcher_database_definition:
+.. _archi_watcher_database_definition:
 
 Watcher Database
 ----------------
 
 This database stores all the Watcher domain objects which can be requested
-by the :ref:`Watcher API <watcher_api_definition>` or the
-:ref:`Watcher CLI <watcher_cli_definition>`:
+by the :ref:`Watcher API <archi_watcher_api_definition>` or the
+:ref:`Watcher CLI <archi_watcher_cli_definition>`:
 
 -  :ref:`Audit templates <audit_template_definition>`
 -  :ref:`Audits <audit_definition>`
@@ -139,7 +139,7 @@ by the :ref:`Watcher API <watcher_api_definition>` or the
 The Watcher domain being here "*optimization of some resources provided by an
 OpenStack system*".
 
-.. _watcher_decision_engine_definition:
+.. _archi_watcher_decision_engine_definition:
 
 Watcher Decision Engine
 -----------------------
@@ -169,10 +169,10 @@ In order to compute the potential :ref:`Solution <solution_definition>` for the
 Audit, the :ref:`Strategy <strategy_definition>` relies on two sets of data:
 
 -   the current state of the
-:ref:`Managed resources <managed_resource_definition>`
-(e.g., the data stored in the Nova database)
+    :ref:`Managed resources <managed_resource_definition>`
+    (e.g., the data stored in the Nova database)
 -   the data stored in the
-:ref:`Cluster History Database <cluster_history_db_definition>`
+    :ref:`Cluster History Database <cluster_history_db_definition>`
     which provides information about the past of the
     :ref:`Cluster <cluster_definition>`
 

doc/source/cmds/watcher-db-manage.rst

@@ -6,9 +6,9 @@
 
 .. _watcher-db-manage:
 
-=============
+=================
 watcher-db-manage
-=============
+=================
 
 The :command:`watcher-db-manage` utility is used to create the database schema
 tables that the watcher services will use for storage. It can also be used to

doc/source/deploy/user-guide.rst

@@ -90,7 +90,7 @@ configuration file.
   $ watcher action-plan-list --audit <the_audit_uuid>
 
 - Have a look on the list of optimization :ref:`actions <action_definition>`
-contained in this new :ref:`action plan <action_plan_definition>`:
+  contained in this new :ref:`action plan <action_plan_definition>`:
 
 .. code:: bash
 

doc/source/dev/contributing.rst

@@ -6,9 +6,9 @@
 
 .. _contributing:
 
-======================
+=======================
 Contributing to Watcher
-======================
+=======================
 
 If you're interested in contributing to the Watcher project,
 the following will help get you started.
@@ -43,7 +43,7 @@ notifications of important events.
 
 
 Project Hosting Details
--------------------------
+-----------------------
 
 Bug tracker
     http://launchpad.net/watcher

doc/source/dev/plugins.rst

@@ -70,7 +70,7 @@ Abstract Plugin Class
 Here below is the abstract ``BaseStrategy`` class that every single strategy
 should implement:
 
-.. automodule:: watcher.decision_engine.strategy.base
+.. automodule:: watcher.decision_engine.strategy.strategies.base
     :noindex:
 
 .. autoclass:: BaseStrategy

doc/source/glossary.rst

@@ -4,9 +4,9 @@
 
           https://creativecommons.org/licenses/by/3.0/
 
-==========
- Glossary
-==========
+========
+Glossary
+========
 
 .. glossary::
    :sorted:
@@ -262,7 +262,7 @@ specific domain.
 Please, read `the official OpenStack definition of a Project <http://docs.openstack.org/glossary/content/glossary.html>`_.
 
 
-.. _primitive_definition
+.. _primitive_definition:
 
 Primitive
 =========

doc/source/index.rst

@@ -8,11 +8,7 @@
 Welcome to Watcher's developer documentation
 ============================================
 
-Mission
-=======
-
-Provide an auditing service for OpenStack to improve workload placement
-on-the-go.
+.. include:: ../../README.rst
 
 The developer documentation provided here is continually kept up-to-date based
 on the latest code, and may not represent the state of the project at any
@@ -29,6 +25,7 @@ Introduction
 
   glossary
   architecture
+  deploy/configuration
   dev/environment
   dev/contributing
   dev/plugins

doc/source/readme.rst

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

doc/source/usage.rst

@@ -1,13 +0,0 @@
-..
-      Except where otherwise noted, this document is licensed under Creative
-      Commons Attribution 3.0 License.  You can view the license at:
-
-          https://creativecommons.org/licenses/by/3.0/
-
-========
-Usage
-========
-
-To use watcher in a project::
-
-    import watcher

doc/source/webapi/v1.rst

@@ -4,15 +4,15 @@
 
           https://creativecommons.org/licenses/by/3.0/
 
-=====================
- RESTful Web API (v1)
-=====================
+====================
+RESTful Web API (v1)
+====================
 
 Audit Templates
 ===============
 
 .. rest-controller:: watcher.api.controllers.v1.audit_template:AuditTemplatesController
-   :webprefix: /v1/audit_template
+   :webprefix: /v1/audit_templates
 
 .. autotype:: watcher.api.controllers.v1.audit_template.AuditTemplateCollection
    :members:
@@ -20,7 +20,6 @@ Audit Templates
 .. autotype:: watcher.api.controllers.v1.audit_template.AuditTemplate
    :members:
 
-
 Audits
 ======
 
@@ -33,24 +32,22 @@ Audits
 .. autotype:: watcher.api.controllers.v1.audit.Audit
    :members:
 
-
 Links
 =====
 
 .. autotype:: watcher.api.controllers.link.Link
    :members:
 
-
-ActionPlans
-===========
+Action Plans
+============
 
 .. rest-controller:: watcher.api.controllers.v1.action_plan:ActionPlansController
    :webprefix: /v1/action_plans
 
-.. autotype:: watcher.api.controllers.v1.action_plan.ActionPlan
+.. autotype:: watcher.api.controllers.v1.action_plan.ActionPlanCollection
    :members:
 
-.. autotype:: watcher.api.controllers.v1.action_plan.ActionPlanCollection
+.. autotype:: watcher.api.controllers.v1.action_plan.ActionPlan
    :members:
 
 

watcher/api/controllers/v1/action_plan.py

@@ -295,7 +295,7 @@ class ActionPlansController(rest.RestController):
         :param sort_key: column to sort results by. Default: id.
         :param sort_dir: direction to sort. "asc" or "desc". Default: asc.
         :param audit_uuid: Optional UUID of an audit, to get only actions
-        for that audit.
+            for that audit.
         """
         return self._get_action_plans_collection(
             marker, limit, sort_key, sort_dir, audit_uuid=audit_uuid)
@@ -307,13 +307,13 @@ class ActionPlansController(rest.RestController):
         """Retrieve a list of action_plans with detail.
 
         :param action_plan_uuid: UUID of a action plan, to get only
-        :action_plans for that action.
+            action_plans for that action.
         :param marker: pagination marker for large data sets.
         :param limit: maximum number of resources to return in a single result.
         :param sort_key: column to sort results by. Default: id.
         :param sort_dir: direction to sort. "asc" or "desc". Default: asc.
         :param audit_uuid: Optional UUID of an audit, to get only actions
-        for that audit.
+            for that audit.
         """
         # NOTE(lucasagomes): /detail should only work agaist collections
         parent = pecan.request.path.split('/')[:-1][-1]

watcher/decision_engine/solution/base.py

@@ -38,7 +38,7 @@ applied.
 Two approaches to dealing with this can be envisaged:
 
 -  **fully automated mode**: only the :ref:`Solution <solution_definition>`
- with the highest ranking (i.e., the highest
+   with the highest ranking (i.e., the highest
    :ref:`Optimization Efficiency <efficiency_definition>`)
    will be sent to the :ref:`Watcher Planner <watcher_planner_definition>` and
    translated into concrete :ref:`Actions <action_definition>`.

watcher/doc.py

@@ -61,9 +61,7 @@ class WatcherTerm(rst.Directive):
         cls_path = self.arguments[0]
 
         try:
-            module_name, obj_name = cls_path.rsplit(".", 1)
-            module = importlib.import_module(module_name)
-            cls = getattr(module, obj_name)
+            cls = importlib.import_module(cls_path)
         except Exception as exc:
             raise self.error(exc)
 

watcher/metrics_engine/cluster_history/api.py

@@ -40,9 +40,9 @@ API is proposed with some helper classes in order to :
    See `the full list of meter types <http://docs.openstack.org/admin-guide-cloud/telemetry-measurements.html>`_
 -  simplify the development of a new :ref:`Strategy <strategy_definition>`
 -  avoid duplicating the same code in several
-:ref:`Strategies <strategy_definition>`
+   :ref:`Strategies <strategy_definition>`
 -  have a better consistency between the different
-:ref:`Strategies <strategy_definition>`
+   :ref:`Strategies <strategy_definition>`
 -  avoid any strong coupling with any external metrics/events storage system
    (the proposed API and measurement naming system acts as a pivot format)
 

watcher/metrics_engine/cluster_model_collector/api.py

@@ -34,7 +34,7 @@ and enables the :ref:`Strategy <strategy_definition>` to request information
 such as:
 
 -  What compute nodes are in a given
-:ref:`Availability Zone <availability_zone_definition>`
+   :ref:`Availability Zone <availability_zone_definition>`
    or a given :ref:`Host Aggregate <host_aggregates_definition>` ?
 -  What :ref:`Instances <instance_definition>` are hosted on a given compute
    node ?