diff options
Diffstat (limited to 'docs/how-to-use-docs/documentation-example.rst')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 18 |
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 54819dc5..ae0a7f23 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 |