diff options
| author |   Chaoyi Huang <joehuang@huawei.com> | 2015-12-22 13:24:10 +0800 |
|---|---|---|
| committer | Chaoyi Huang <joehuang@huawei.com> | 2016-01-04 11:01:31 +0800 |
| commit | 8e3d1f151aa2ba629c9ed4ad61862ac147fff3ec (patch) | |
| tree | cc042c0c9934f13c8a6d3f868421ec38550111d8 /docs/how-to-use-docs/documentation-example.rst | |
| parent | 1a148540057b9bcbc32865217319021ba09ae07b (diff) | |
Add doc and update output according OpenStack spec's updatebrahmaputra.1.0
Add admin-user-guide and configuration-guide for multisite, and update
the output requirement to sync. the change in OpenStack spec, which was
reviewed in OpenStack community
Change-Id: Icff3dda7e204404f8003d6e06cde45151eb03446
Signed-off-by: Chaoyi Huang <joehuang@huawei.com>
Diffstat (limited to 'docs/how-to-use-docs/documentation-example.rst')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 9 |
1 files changed, 5 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..24b4c8a 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,8 +21,9 @@ 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 @@ -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 |