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
This commit is contained in:
David TARDIVEL
2016-01-15 09:22:25 +01:00
parent 037f43cd04
commit c811051351
15 changed files with 40 additions and 62 deletions

View File

@@ -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>`

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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
=========

View File

@@ -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

View File

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

View File

@@ -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

View File

@@ -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: