diff options
author | 2015-12-21 09:05:29 +0000 | |
---|---|---|
committer | 2015-12-21 09:05:29 +0000 | |
commit | 828f613ea0c3e334eacf3f7857252246708d1c88 (patch) | |
tree | 9309dd3ff54bcbc5885d266598bfbb24c05fffa4 /docs/documentation-example.rst | |
parent | 823734760ba315c8edc6d27475288c7b34930e58 (diff) | |
parent | bb600a64bb9105dbe0bc3b971067c193a29861d2 (diff) |
Merge "Define a TOSCA template for a vRNC(new)"
Diffstat (limited to 'docs/documentation-example.rst')
-rw-r--r-- | docs/documentation-example.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/documentation-example.rst b/docs/documentation-example.rst index ebd80e4..8264732 100644 --- a/docs/documentation-example.rst +++ b/docs/documentation-example.rst @@ -12,8 +12,8 @@ this is the directory structure of the docs/ directory that can be found in the ./documentation-example.rst ./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 @@ -46,11 +46,13 @@ 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 +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 |