summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-compass4nfv
diff options
context:
space:
mode:
Diffstat (limited to 'docs/how-to-use-compass4nfv')
-rw-r--r--docs/how-to-use-compass4nfv/documentation-compass4nfv.rst42
-rw-r--r--docs/how-to-use-compass4nfv/index.rst13
2 files changed, 13 insertions, 42 deletions
diff --git a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst b/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst
index c9e40dd7..7fbd1578 100644
--- a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst
+++ b/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst
@@ -544,45 +544,3 @@ How to integration plugins
-
-
-
-
-
-
-The Sphinx Build
-================
-
-When you push documentation changes to gerrit a jenkins job will create html documentation.
-
-* Verify Jobs
-
-For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
-
-* Merge jobs
-
-Once you are happy with the look of your documentation you can submit the patchset
-the merge job will copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
-
-Here are some quick examples of how to use rst markup
-
-This is a headline::
-
- here is some code, note that it is indented
-
-links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
-
-* Bulleted Items
-
- **this will be bold**
-
-.. code-block:: bash
-
- echo "Heres is a code block with bash syntax highlighting"
-
-
-Leave these at the bottom of each of your documents they are used internally
-
-Revision: _sha1_
-
-Build date: |today|
diff --git a/docs/how-to-use-compass4nfv/index.rst b/docs/how-to-use-compass4nfv/index.rst
new file mode 100644
index 00000000..f4a5bdeb
--- /dev/null
+++ b/docs/how-to-use-compass4nfv/index.rst
@@ -0,0 +1,13 @@
+*********************
+Compass4nfv Project
+*********************
+
+Contents:
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ how-to-use-compass4nfv/documentation-compass4nfv.rst
+ how-to-use-compass4nfv/compass4nfv_host_network.png
+ how-to-use-compass4nfv/compass4nfv_network_topology.png