1 .. two dots create a comment. please leave this logo at the top of each of your rst files.
2 .. image:: ../etc/opnfv-logo.png
7 .. these two pipes are to seperate the logo from the first title
10 How to create documentation for your OPNFV project
11 ==================================================
13 this is the directory structure of the docs/ directory that can be found in the root of your project directory
21 ./how-to-use-docs/documentation-example.rst
22 ./how-to-use-docs/index.rst
24 To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.
25 This index file must refence your other rst files.
27 * Here is an example index.rst
31 Example Documentation table of contents
32 =======================================
40 documentation-example.rst
55 When you push documentation changes to gerrit a jenkins job will create html documentation.
58 For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
62 Once you are happy with the look of your documentation you can submit the patchset the merge job will
63 copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
65 Here are some quick examples of how to use rst markup
69 here is some code, note that it is indented
71 links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
79 echo "Heres is a code block with bash syntax highlighting"
82 Leave these at the bottom of each of your documents they are used internally