summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/index.rst
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2015-09-10 15:40:56 -0400
committerAric Gardner <agardner@linuxfoundation.org>2015-09-10 15:41:05 -0400
commit4e63eda834fbaee8e910f2cb0f6ca3ca84709445 (patch)
treee5d8e650915260e51b837cbffac23969717021f9 /docs/how-to-use-docs/index.rst
parent5a746b80d76d53bff63e4dac735c6bee4e8114c0 (diff)
Example as code, documentation template for sphinx build
This code will be pushed to each project creating a docs/ directory This servers as an example and template for you (the developers) to create your own project documentation Change-Id: I084e0af553c9f7e503fb55a3dd4990edbcf3394d JIRA:RELENG-15 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs/how-to-use-docs/index.rst')
-rw-r--r--docs/how-to-use-docs/index.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst
new file mode 100644
index 0000000..36710b3
--- /dev/null
+++ b/docs/how-to-use-docs/index.rst
@@ -0,0 +1,30 @@
+.. OPNFV Release Engineering documentation, created by
+ sphinx-quickstart on Tue Jun 9 19:12:31 2015.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+.. image:: ../etc/opnfv-logo.png
+ :height: 40
+ :width: 200
+ :alt: OPNFV
+ :align: left
+
+Example Documentation table of contents
+=======================================
+
+Contents:
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ documentation-example.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|