summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/documentation-example.rst
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2015-09-10 15:17:20 -0400
committerAric Gardner <agardner@linuxfoundation.org>2015-09-10 15:22:46 -0400
commitfe5a64076ebffa3a21d367ff84e6e50ab563aab2 (patch)
tree570726ca3bdb3efc90f03fcf077227f02e4f5a23 /docs/how-to-use-docs/documentation-example.rst
parent465ae02e43e5d363303bbf8dac4692c42a34543f (diff)
Example as code, documentation template for sphinx build
This code will be pushed to each project as an example to the devs. JIRA:RELENG-15 Change-Id: I7f0a718ffb8c318b8ab0bd5ba3fa4dd9176625a8 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs/how-to-use-docs/documentation-example.rst')
-rw-r--r--docs/how-to-use-docs/documentation-example.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
new file mode 100644
index 00000000..afcf7581
--- /dev/null
+++ b/docs/how-to-use-docs/documentation-example.rst
@@ -0,0 +1,86 @@
+.. 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
+==================================================
+
+this is the directory structure of the docs/ directory that can be found in the root of your project directory
+
+.. code-block:: bash
+
+ ./etc
+ ./etc/opnfv-logo.png
+ ./etc/conf.py
+ ./how-to-use-docs
+ ./how-to-use-docs/documentation-example.rst
+ ./how-to-use-docs/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|