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
8 .. these two pipes are to seperate the logo from the first title
13 How to create documentation for your OPNFV project
14 ==================================================
16 this is the directory structure of the docs/ directory that can be found in the root of your project
25 ./how-to-use-docs/documentation-example.rst
26 ./how-to-use-docs/index.rst
28 To create your own documentation, Create any number of directories (depending on your need) and
29 place in each of them an index.rst. This index file must refence your other rst files.
31 * Here is an example index.rst
35 Example Documentation table of contents
36 =======================================
44 documentation-example.rst
55 When you push documentation changes to gerrit a jenkins job will create html documentation.
59 For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the
64 Once you are happy with the look of your documentation you can submit the patchset the merge job
65 will copy the output of each documentation directory to
66 http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
68 Here are some quick examples of how to use rst markup
72 here is some code, note that it is indented
74 links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation
75 http://sphinx-doc.org/
83 echo "Heres is a code block with bash syntax highlighting"
86 Leave these at the bottom of each of your documents they are used internally