diff options
author | shangxdy <shang.xiaodong@zte.com.cn> | 2015-12-18 16:27:00 +0800 |
---|---|---|
committer | shangxdy <shang.xiaodong@zte.com.cn> | 2015-12-21 14:56:48 +0800 |
commit | bb600a64bb9105dbe0bc3b971067c193a29861d2 (patch) | |
tree | 433fc0cbb4530ac5a6d60365ab8f48bc0c7afc1d /docs/documentation-example.rst | |
parent | 879f32a9c48cb9f59b9b0c322cecc58f7ac824d1 (diff) |
Define a TOSCA template for a vRNC(new)
Define a vRNC(an VNF of Radio Network Controller) by using TOSCA template.
Recheck for changed documents architecture.
JIRA:PARSER-7
Change-Id: I3164b262b2cf3e82f0afc6e3663331d886741c96
Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
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 |