JIRA: IPVSIX-29 39/4739/1
authorBin Hu <bh526r@att.com>
Thu, 17 Dec 2015 01:58:31 +0000 (17:58 -0800)
committerBin Hu <bh526r@att.com>
Thu, 17 Dec 2015 01:58:55 +0000 (17:58 -0800)
Change-Id: I27b63525cd20fe44616b0996290b831b2cdbad35
Signed-off-by: Bin Hu <bh526r@att.com>
docs/how-to-use-docs/documentation-example.rst
docs/setupservicevm/index.rst [new file with mode: 0644]

index afcf758..5f75db5 100644 (file)
@@ -1,12 +1,14 @@
 .. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png 
+.. image:: ../etc/opnfv-logo.png
   :height: 40
   :width: 200
   :alt: OPNFV
   :align: left
 .. these two pipes are to seperate the logo from the first title
 |
+
 |
+
 How to create documentation for your OPNFV project
 ==================================================
 
@@ -21,8 +23,8 @@ this is the directory structure of the docs/ directory that can be found in the
     ./how-to-use-docs/documentation-example.rst
     ./how-to-use-docs/index.rst
 
-To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.
-This index file must refence your other rst files.
+To create your own documentation, Create any number of directories (depending on your need) and place in each of them
+an index.rst. This index file must refence your other rst files.
 
 * Here is an example index.rst
 
@@ -55,11 +57,12 @@ 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 
+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
diff --git a/docs/setupservicevm/index.rst b/docs/setupservicevm/index.rst
new file mode 100644 (file)
index 0000000..ff1ea79
--- /dev/null
@@ -0,0 +1,30 @@
+.. OPNFV Release Engineering documentation, created by
+   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+
+Example Documentation table of contents
+=======================================
+
+Contents:
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   ipv6-configguide.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|