Removed warnings from building docs

Removed all warnings from running 'tox -e docs'.
Setting warnerrors = true in setup.cfg.

Change-Id: I00438f6a505d696fa5d1261a4f016118bdd4faf1
Closes-Bug: #1561985

doc/source/articles/telnet_example.rst

@@ -0,0 +1,59 @@
+..
+      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.
+..
+.. _telnet-example:
+
+Telnet Example
+--------------
+
+.. code-block:: yaml
+
+    Namespaces:
+      =: io.murano.apps.linux
+      std: io.murano
+      res: io.murano.resources
+
+
+    Name: Telnet
+
+    # Inheritance from io.murano.Application class
+    # (located at Murano Core library) indicates,
+    # that this is a complete application
+    # and that 'deploy' method has to be defined.
+    Extends: std:Application
+
+    Properties:
+      name:
+        Contract: $.string().notNull()
+
+      instance:
+        Contract: $.class(res:Instance).notNull()
+
+
+    Methods:
+      deploy:
+        Body:
+          # Determine the environment to which the application belongs.
+          # This message will be stored in deployment logs and available in UI
+          - $this.find(std:Environment).reporter.report($this, 'Creating VM for Telnet instace.')
+          # Deploy VM
+          - $.instance.deploy()
+          - $this.find(std:Environment).reporter.report($this, 'Instance is created. Setup Telnet service.')
+          # Create instance of murano resource class. Agent will use it to find
+          # corresponding execution plan by the file name
+          - $resources: new('io.murano.system.Resources')
+          # Deploy Telnet
+          - $template: $resources.yaml('DeployTelnet.template')
+          # Send prepared execution plan to Murano agent
+          - $.instance.agent.call($template, $resources)
+          - $this.find(std:Environment).reporter.report($this, 'Telnet service setup is done.')

doc/source/articles/workflow.rst

@@ -42,14 +42,14 @@ parameters the user selected prior to deployment. Examples are:
 Each object in this *model* has an ID so that the state of each can be tracked.
 
 The classes that are required are determined by the application's manifest. In
-the :ref:`Telnet example <Telnet Manifest>` only one class is explicitly
+the :ref:`Telnet example <telnet-example>` only one class is explicitly
 required; the telnet application definition.
 
-The :ref:`Telnet class definition <Telnet Class>` refers to several other
+The :ref:`Telnet class definition <telnet-example>` refers to several other
 classes. It extends :ref:`Application` and it requires an :ref:`Instance`.
 It also refers to the :ref:`Environment` in which it will be contained,
-sends reports through the environment's :ref:`io.murano.system.StatusReporter`
-and adds security group rules to the :ref:`SecurityGroupManager`.
+sends reports through the environment's :ref:`status-reporter`
+and adds security group rules to the :ref:`security-group-manager`.
 
 
 Step 2.  Load definitions
@@ -75,7 +75,7 @@ to murano-agent (see later). The next stage is to deploy each application the
 environment knows about in turn, by running deploy() for each application.
 This happens concurrently for all the applications belonging to an instance.
 
-In the :ref:`Telnet example <Telnet Class>` (under *Workflow*), the workflow
+In the :ref:`Telnet example <telnet-example>` (under *Workflow*), the workflow
 dictates sending a status message (via the environment's *reporter*, and
 configuring some security group rules. It is at this stage that the engine
 first contacts Heat to request information about any pre-existing resources

doc/source/draft/admin-guide/policy_enf.rst

@@ -40,7 +40,6 @@ the deployment fails as well.
 .. _Congress: https://wiki.openstack.org/wiki/Congress
 
 
-.. include:: /draft/admin-guide/policy_enforcement/policy_enf_overview.rst
 .. include:: /draft/admin-guide/policy_enforcement/policy_enf_setup.rst
 .. include:: /draft/admin-guide/policy_enforcement/policy_enf_rules.rst
 .. include:: /draft/admin-guide/policy_enforcement/policy_enf_dev.rst

doc/source/draft/appdev-guide/hotpackages/compose.rst

@@ -15,7 +15,7 @@ Just choose the desired Heat Orchestration Template and perform the following co
 
 ::
 
-murano package-create  --template wordpress/template.yaml
+  murano package-create  --template wordpress/template.yaml
 
 Note, that optional parameters could be specified:
 
@@ -77,10 +77,10 @@ Application package could be composed manually. Follow the 5 steps below.
 
 `Applications` page looks like:
 
-.. image:: chef_server.png
+.. image:: /draft/appdev-guide/hotpackages/chef_server.png
 
 The configuration form, where you can enter template parameters, will be generated automatically and looks as follows:
 
-.. image:: chef_server_form.png
+.. image:: /draft/appdev-guide/hotpackages/chef_server_form.png
 
 After filling the form the application is ready to be deployed.

doc/source/draft/appdev-guide/murano_pl/actions.rst

@@ -1,8 +1,8 @@
-.. _actions:
-
 .. toctree::
    :maxdepth: 2
 
+.. _actions:
+
 ==============
 Murano actions
 ==============
@@ -74,4 +74,4 @@ Response:
           }
         }
       }
-    }
+    }

doc/source/draft/appdev-guide/murano_pl/core_lib.rst

@@ -27,6 +27,7 @@ Classes included in the Murano core library are as follows:
 **io.murano.system**
 
 - :ref:`logger`
+- :ref:`status-reporter`
 
 
 .. _object:
@@ -321,3 +322,17 @@ This method uses the ERROR level:
 
   * `OpenStack networking logging
     configuration <http://docs.openstack.org/liberty/config-reference/content/networking-options-logging.html>`_.
+
+.. _status-reporter:
+
+Class: StatusReporter
+---------------------
+
+Provides feedback feature. To follow the deployment process in the UI, all status changes should be included
+in the application configuration.
+
+.. seealso::
+
+   Source `StatusReporter.yaml
+   <https://git.openstack.org/cgit/openstack/murano/tree/meta/io.murano/Classes/system/StatusReporter.yaml>`_
+   file.

doc/source/draft/appdev-guide/muranopackages/package_structure.rst

@@ -38,4 +38,4 @@ The application package root folder should contain the following:
 Here is the visual representation of the Murano application
 package structure:
 
-.. image:: muranopackages/structure.png
+.. image:: /draft/appdev-guide/muranopackages/structure.png

doc/source/draft/index.rst

@@ -102,7 +102,7 @@ Contributing
    contributor-guide/how_to_contribute
    contributor-guide/dev_guidelines
    contributor-guide/plugins
-   contributor-guide/deploy_local_dev_env
+   contributor-guide/dev_env
    contributor-guide/testing
    contributor-guide/doc_guidelines
 

doc/source/index.rst

@@ -83,7 +83,7 @@ Using Murano
    draft/enduser-guide/quickstart
    draft/enduser-guide/manage_environments
    draft/enduser-guide/manage_applications
-   draft/enduser-guide/log_into_murano_instance
+   draft/enduser-guide/log_in_to_murano_instance
    draft/enduser-guide/deploying_using_cli
 
 

doc/source/specification/murano-env-temp.rst

@@ -342,7 +342,7 @@ Get applications information from an environment template
 
 +----------+-------------------------------------+-----------------------------------+
 | Method   | URI                                 | Description                       |
-+==========+====================================+====================================+
++==========+=====================================+===================================+
 | GET      | /templates/{env-temp-id}/services   | It obtains the service description|
 +----------+-------------------------------------+-----------------------------------+
 
@@ -408,7 +408,7 @@ Create an environment from an environment template
 
 +----------+--------------------------------------------+--------------------------------------+
 | Method   | URI                                        | Description                          |
-+==========+================================+==================================================+
++==========+============================================+======================================+
 | POST     | /templates/{env-temp-id}/create-environment| Create an environment                |
 +----------+--------------------------------------------+--------------------------------------+
 

setup.cfg

@@ -86,3 +86,8 @@ input_file = murano/locale/murano.pot
 keywords = _ gettext ngettext l_ lazy_gettext
 mapping_file = babel.cfg
 output_file = murano/locale/murano.pot
+
+[pbr]
+# Treat sphinx warnings as errors during the docs build; this helps us keep
+# the documentation clean.
+warnerrors = true