summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs
diff options
context:
space:
mode:
author10013968 <zhang.jun3g@zte.com.cn>2016-07-18 23:51:00 +0800
committer10013968 <zhang.jun3g@zte.com.cn>2016-07-27 23:49:59 +0800
commit988cf64e3a7601396e40b08a1aae07a524bf8c74 (patch)
treec4faf0b011473671e833df539c04e79de4884608 /docs/how-to-use-docs
parentd9a002cba4741400c8b8d34e5bddb8cf33fb4e3c (diff)
Reformat the rst documents
Main changes: Set the textwidth to 100, exceptions: tables and http links may be longer than the limits Cut off the table width as shorten as possible JIRA: PHAROS-227 Change-Id: I07861e675d76ab5063f388d3be7d0b51c8bad38b Signed-off-by: 10013968 <zhang.jun3g@zte.com.cn>
Diffstat (limited to 'docs/how-to-use-docs')
-rw-r--r--docs/how-to-use-docs/documentation-example.rst18
1 files changed, 11 insertions, 7 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
index 54819dc..ae0a7f2 100644
--- a/docs/how-to-use-docs/documentation-example.rst
+++ b/docs/how-to-use-docs/documentation-example.rst
@@ -13,7 +13,8 @@
How to create documentation for your OPNFV project
==================================================
-this is the directory structure of the docs/ directory that can be found in the root of your project directory
+this is the directory structure of the docs/ directory that can be found in the root of your project
+directory
.. code-block:: bash
@@ -24,8 +25,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,12 +56,14 @@ When you push documentation changes to gerrit a jenkins job will create html doc
* Verify Jobs
-For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
+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
@@ -68,7 +71,8 @@ This is a headline::
here is some code, note that it is indented
-links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
+links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation
+http://sphinx-doc.org/
* Bulleted Items