+++ /dev/null
-.. two dots create a comment. please leave this logo at the top of each of your rst files.\r
-.. image:: ../etc/opnfv-logo.png \r
- :height: 40\r
- :width: 200\r
- :alt: OPNFV\r
- :align: left\r
-.. these two pipes are to seperate the logo from the first title\r
-|\r
-|\r
-How to create documentation for your OPNFV project\r
-==================================================\r
-\r
-this is the directory structure of the docs/ directory that can be found in the root of your project directory\r
-\r
-.. code-block:: bash\r
-\r
- ./etc\r
- ./etc/opnfv-logo.png\r
- ./etc/conf.py\r
- ./how-to-use-docs\r
- ./how-to-use-docs/documentation-example.rst\r
- ./how-to-use-docs/index.rst\r
-\r
-To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.\r
-This index file must refence your other rst files.\r
-\r
-* Here is an example index.rst\r
-\r
-.. code-block:: bash\r
-\r
- Example Documentation table of contents\r
- =======================================\r
-\r
- Contents:\r
-\r
- .. toctree::\r
- :numbered:\r
- :maxdepth: 4\r
-\r
- documentation-example.rst\r
-\r
- Indices and tables\r
- ==================\r
-\r
- * :ref:`search`\r
-\r
- Revision: _sha1_\r
-\r
- Build date: |today|\r
-\r
-\r
-The Sphinx Build\r
-================\r
-\r
-When you push documentation changes to gerrit a jenkins job will create html documentation.\r
-\r
-* Verify Jobs\r
-For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.\r
-\r
-* Merge jobs\r
-\r
-Once you are happy with the look of your documentation you can submit the patchset the merge job will \r
-copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html\r
-\r
-Here are some quick examples of how to use rst markup\r
-\r
-This is a headline::\r
-\r
- here is some code, note that it is indented\r
-\r
-links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/\r
-\r
-* Bulleted Items\r
-\r
- **this will be bold**\r
-\r
-.. code-block:: bash\r
-\r
- echo "Heres is a code block with bash syntax highlighting"\r
-\r
-\r
-Leave these at the bottom of each of your documents they are used internally\r
-\r
-Revision: _sha1_\r
-\r
-Build date: |today|\r
+++ /dev/null
-.. OPNFV Release Engineering documentation, created by\r
- sphinx-quickstart on Tue Jun 9 19:12:31 2015.\r
- You can adapt this file completely to your liking, but it should at least\r
- contain the root `toctree` directive.\r
-\r
-.. image:: ../etc/opnfv-logo.png\r
- :height: 40\r
- :width: 200\r
- :alt: OPNFV\r
- :align: left\r
-\r
-Example Documentation table of contents\r
-=======================================\r
-\r
-Contents:\r
-\r
-.. toctree::\r
- :numbered:\r
- :maxdepth: 4\r
-\r
- documentation-example.rst\r
-\r
-Indices and tables\r
-==================\r
-\r
-* :ref:`search`\r
-\r
-Revision: _sha1_\r
-\r
-Build date: |today|\r