diff options
| author |   Bin Hu <bh526r@att.com> | 2015-12-16 17:58:31 -0800 |
|---|---|---|
| committer | Bin Hu <bh526r@att.com> | 2015-12-16 17:58:55 -0800 |
| commit | 715761a602504c9fd2192b8942d09ad1be0378a7 (patch) | |
| tree | 20548945c0d4470bc3cbcc0639df0eaba1966a87 /docs/how-to-use-docs | |
| parent | b798270a0b7e0cf5a7393cb7dc990265eecc2be2 (diff) | |
JIRA: IPVSIX-29
Change-Id: I27b63525cd20fe44616b0996290b831b2cdbad35
Signed-off-by: Bin Hu <bh526r@att.com>
Diffstat (limited to 'docs/how-to-use-docs')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index afcf758..5f75db5 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -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 |