1 How to create documentation for your OPNFV project
2 ==================================================
4 this is the directory structure of the docs/ directory that can be found in the root of your project directory
12 ./how-to-use-docs/documentation-example.rst
13 ./how-to-use-docs/index.rst
15 To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.
16 This index file must refence your other rst files.
18 * Here is an example index.rst
32 documentation-example.rst
35 Leave these at the bottom of 'index.rst' file
45 When you push documentation changes to gerrit a jenkins job will create html documentation.
49 For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
53 Once you are happy with the look of your documentation you can submit the patchset the merge job will
54 copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
56 Here are some quick examples of how to use rst markup
60 here is some code, note that it is indented
62 links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
70 echo "Heres is a code block with bash syntax highlighting"