Merge "Added section about submodules"
[doc.git] / docs / guides / onap-developer / how-to-use-docs / include-documentation.rst
index 789ad75..b1caff8 100644 (file)
@@ -3,6 +3,7 @@
 
 Setting Up
 ==========
+
 Some initial set up is required to connect a project with
 the master document structure and enable automated publishing of
 changes as summarized in the following diagram and description below 
@@ -130,11 +131,12 @@ to convert or add new content you can update the index and add files under the d
 The diagram below illustrates what is accomplished in the setup steps
 above from the perspective of a file structure created for a local test,
 a jenkins verify job, and/or published release documentation including:
-  - ONAP gerrit project repositories,
-  - doc project repository master document index.rst, templates, configuration, and other documents
-  - submodules directory where other project repositories and directories/files are referenced 
-  - file structure: directories (ellipses), files(boxes)
-  - references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges)
+
+- ONAP gerrit project repositories,
+- doc project repository master document index.rst, templates, configuration, and other documents
+- submodules directory where other project repositories and directories/files are referenced 
+- file structure: directories (ellipses), files(boxes)
+- references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges)
 
 
 .. graphviz::
@@ -340,6 +342,7 @@ specified output folder directory.
 
 .. note:: Be sure to remove the `conf.py`, the static/ files and the output folder from the `<project>/docs/`. This is for testing only. Only commit the rst files and related content.
 
+.. _building-all-documentation:
 
 All Documentation
 -----------------