diff options
| author |   Mofassir <Mofassir_arif@Dellteam.com> | 2016-01-05 09:20:58 -0800 |
|---|---|---|
| committer | Mofassir <Mofassir_arif@Dellteam.com> | 2016-01-05 09:35:40 -0800 |
| commit | cb47406502e3ab9029530e82cacc2f9f012d5bd3 (patch) | |
| tree | 274dddab862b0374701f05194f1ec8351dff41c0 /docs/how-to-use-docs/documentation-example.rst | |
| parent | 57922dcb8e6497f02fdee9306494e932e25dcace (diff) | |
I have added the placeholder documentation files and
folders. They will be editted in time for the release
Change-Id: Id69392233399ad536b359da5733dfaa43a602443
Signed-off-by: Mofassir <Mofassir_arif@Dellteam.com>
Diffstat (limited to 'docs/how-to-use-docs/documentation-example.rst')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index afcf7581..89b95075 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -1,5 +1,5 @@ .. 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 @@ -21,7 +21,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. +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 @@ -59,7 +60,7 @@ For verify jobs a link to the documentation will show up as a comment in gerrit * 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 |