Merge "Remove OpFlex out of Fluorine."
[docs.git] / docs / developer-guide / topology-processing-framework-developer-guide.rst
index f1d17c39588b62f2861194875e6439fd26acc753..ae5decbefee5d238a6e173f2461ef4a09d419576 100644 (file)
@@ -1,3 +1,5 @@
+.. _topoprocessing-dev-guide:
+
 Topology Processing Framework Developer Guide
 =============================================
 
@@ -466,7 +468,7 @@ pieces are:
 
 -  output model
 
-.. code:: yang
+.. code::
 
     leaf output-model {
         type identityref {
@@ -477,7 +479,7 @@ pieces are:
 
 -  overlay topology with new nodes
 
-.. code:: yang
+.. code::
 
     container node-info {
         leaf node-topology {
@@ -491,7 +493,7 @@ pieces are:
 
 -  underlay topologies with original links
 
-.. code:: yang
+.. code::
 
     list link-info {
         key "link-topology input-model";
@@ -715,7 +717,7 @@ picture below shows how data will be rendered and stored.
 
    Rendering to the inventory-rendering model
 
-    **Important**
+.. important::
 
     When implementing your version of the topology-rendering model in
     the Topology Processing Framework, the source file of the model
@@ -728,7 +730,7 @@ which you can set your new model as output model. To do that you have to
 add another identity item to topology-correlation.yang file. For our
 inventory-rendering model identity looks like this:
 
-.. code:: yang
+.. code::
 
     identity inventory-rendering-model {
         description "inventory-rendering.yang";
@@ -741,7 +743,7 @@ model in XML.
 Step2 - Module and Feature Creation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    **Important**
+.. important::
 
     This and following steps are based on the `model specific
     approach <#_model_specific_approach>`__ in the Topology Processing
@@ -813,7 +815,7 @@ IRModelAdapter refers to class which implements ModelAdapter in module
 Inventory Rendering). In the case of the provider class, we put the
 abbreviation at the end.
 
-    **Important**
+.. important::
 
     -  In the next sections, we use the terms TopologyRequestListener,
        TopologyRequestHandler, etc. without a prepended or appended
@@ -877,7 +879,7 @@ processing. In this case, we had to create five classes implementing:
    the rendering operator just wraps each received UnderlayItem to
    OverlayItem and sends them to write.
 
-    **Important**
+.. important::
 
     For purposes of topology rendering from inventory to
     network-topology, there are misused fields in UnderlayItem as
@@ -1277,4 +1279,3 @@ API Reference Documentation
 
 You can find API examples on `this wiki
 page <https://wiki.opendaylight.org/view/Topology_Processing_Framework:Developer_Guide:REST_API_Specification>`__.
-