diff options
author | zhipengh <huangzhipeng@huawei.com> | 2016-01-07 16:33:16 +0800 |
---|---|---|
committer | zhipengh <huangzhipeng@huawei.com> | 2016-01-07 16:52:02 +0800 |
commit | a83cb309a399fd3043695e6620441d8d8ec7727d (patch) | |
tree | 4e45d75e692204eac1b1a728c815c7e95e6f6673 /docs/documentation-example.rst | |
parent | ad5974ac97515d79292d08990dfbfd56b7489ab9 (diff) |
JIRA:PARSER-17 Clean up documentation setup
Change-Id: I2863a76a5d5417c184283fdf97282c94359162dc
Diffstat (limited to 'docs/documentation-example.rst')
-rw-r--r-- | docs/documentation-example.rst | 78 |
1 files changed, 0 insertions, 78 deletions
diff --git a/docs/documentation-example.rst b/docs/documentation-example.rst deleted file mode 100644 index 8264732..0000000 --- a/docs/documentation-example.rst +++ /dev/null @@ -1,78 +0,0 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. - -How to create documentation for your OPNFV project -================================================== - -this is the directory structure of the docs/ directory that can be found in the root of your project directory - -.. code-block:: bash - - ./yourfolder_name1/file_name1.rst - ./yourfolder_nameN/file_nameX.rst - ./documentation-example.rst - ./index.rst - -To create your own documentation, Create any number of directories (depending on your need) and place -in each of them an index.rst. This index file must refence your other rst files. - -* Here is an example index.rst - -.. code-block:: bash - - Example Documentation table of contents - ======================================= - - Contents: - - .. toctree:: - :numbered: - :maxdepth: 4 - - documentation-example.rst - - Indices and tables - ================== - - * :ref:`search` - - Revision: _sha1_ - - Build date: |today| - - -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 -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 - -This is a headline:: - - here is some code, note that it is indented - -links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/ - -* Bulleted Items - - **this will be bold** - -.. 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| |