diff options
Diffstat (limited to 'docs/how-to-use-docs/documentation-example.rst')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 30 |
1 files changed, 7 insertions, 23 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index afcf75814..e18ce598b 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -1,12 +1,3 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left -.. these two pipes are to seperate the logo from the first title -| -| How to create documentation for your OPNFV project ================================================== @@ -28,8 +19,9 @@ This index file must refence your other rst files. .. code-block:: bash - Example Documentation table of contents - ======================================= + ===================== + Example Documentation + ===================== Contents: @@ -39,10 +31,8 @@ This index file must refence your other rst files. documentation-example.rst - Indices and tables - ================== - - * :ref:`search` + .. + Leave these at the bottom of 'index.rst' file Revision: _sha1_ @@ -55,11 +45,12 @@ The Sphinx Build When you push documentation changes to gerrit a jenkins job will create html documentation. * Verify Jobs + 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 +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 @@ -77,10 +68,3 @@ links are easy to add: Here is a link to sphinx, the tool that we are using to g .. code-block:: bash echo "Heres is a code block with bash syntax highlighting" - - -Leave these at the bottom of each of your documents they are used internally - -Revision: _sha1_ - -Build date: |today| |