Fix doc gate failure

This patch set fixes the blocking documentation gate failure for Gluon.

Change-Id: Ic1e1b2ea8c65ba9d29940d1e9034857bfc78d0c6

.gitignore

@@ -60,3 +60,6 @@ releasenotes/build
 .idea
 gluon/gluon.sqlite
 gluon/clean.sqlite
+
+doc/source/api
+doc/source/modules.rst

doc/source/devref/database_migration.rst

@@ -2,7 +2,6 @@
 Database Migration Strategy
 ===========================
 
--------------------------------
 What happens on a model change?
 -------------------------------
 
@@ -15,8 +14,6 @@ Similar to Neutron migration strategy a script for auto generation is used:
 The big difference is that Proton will have a YAML model. So a new
 auto generate script is needed.
 
-
------------------
 Migration Process
 -----------------
 
@@ -32,7 +29,6 @@ See details in the devref:
 `Neutron Database Migration <http://docs.openstack.org/developer/neutron/devref/alembic_migrations.html>`_
 
 
--------
 Testing
 -------
 

doc/source/devref/gluon-auth.rst

@@ -90,6 +90,8 @@ Following will be the default rules:
 
 The actions are defined within the "policies" section as shown below.
 
+.. code-block:: yaml
+
   ProtonBasePort:
       ...
       existing model definition
@@ -122,6 +124,8 @@ Converting to policy.json file
 During the installation of Gluon, the embedded policies in the YAML model file will be converted
 to /etc/gluon/policy.json file. This file will have the following format.
 
+.. code-block:: json
+
   {
       "context_is_admin":  "role:admin or user_name:gluon",
       "owner": "tenant_id:%(tenant_id)s",

doc/source/devref/high_level_design.rst

@@ -99,6 +99,7 @@ information from ``etcd``.
 The ``ports`` can be viewed using the command:
 
 .. code-block:: bash
+
   $ protonclient --api net-l3vpn port-list
 
 More generic command is something like:

doc/source/devref/index.rst

@@ -32,6 +32,6 @@ Gluon Developer Docs
 .. include:: service_binding_model.rst
 .. include:: database_migration.rst
 .. include:: gluon-auth.rst
-.. include:: gluon-api-spec.rst
+.. include:: gluon_api_spec.rst
 .. include:: gluon_proton_versioning.rst
 .. include:: repo_structure.rst

doc/source/devref/service_binding_model.rst

@@ -12,7 +12,7 @@ creating new network service APIs. It hence supports developers in making the
 best use of the flexibility provided by Gluon.
 
 This model is based on the "service binding pattern" described in the NetReady
-requirements document [1]_ and was adapted for Gluon.
+requirements document [0]_ and was adapted for Gluon.
 
 The modeling tools in Gluon provide building blocks to allow the creation of
 arbitrarily complex networking APIs.  However, some constraints are needed to
@@ -427,5 +427,5 @@ between these objects and objects extended from base objects.
 
 References
 
-.. [1] NetReady - Service Binding model: http://artifacts.opnfv.org/netready/colorado/docs/requirements/index.html#service-binding-design-pattern
+.. [0] NetReady - Service Binding model: http://artifacts.opnfv.org/netready/colorado/docs/requirements/index.html#service-binding-design-pattern
 

doc/source/devref/task_list.rst

@@ -43,18 +43,28 @@ For Enhancements of Gluon Implementation
 ----------------------------------------
 
 #. Investigate how different VIF drivers can be used for different port types on the same hypervisor
+
    #. Need to understand VIF plugging and how it affects Gluon
    #. Generic VIF driver may be okay for most use cases
+
 #. Investigate and resolve synchronization issues in the gluon/proton architecture
+
    #. Need to re-sync proton with gluon upon restart
+
       #. This is partially done
+
    #. Synchronization of mysql and etcd databases needs to be investigated
+
       #. Are we covered if Proton restarts or etcd is unavailable for a period of time?
+
 #. Synchronize bind operation with SDN controller
+
    #. There is no feedback if the SDN bind fails
    #. Need to make sure bind is done before VM is spawned. Synchronize bind with port_update response
    #. Binding information needs to be pushed back to Proton
+
       #. Should Proton just read this from etcd?
+
 #. Rebuild Gluon to not use particle generator
 
 ------------------------------------