aboutsummaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/index.rst
diff options
context:
space:
mode:
authorFatih Degirmenci <fatih.degirmenci@ericsson.com>2015-11-08 19:41:02 -0800
committerFatih Degirmenci <fatih.degirmenci@ericsson.com>2015-11-08 19:46:58 -0800
commitc0c1a3e9be0c8c7bdd73700fc34873720bfd81aa (patch)
tree8a4c410b341e38b63e7c37b0e541cc063fdf6ab6 /docs/how-to-use-docs/index.rst
parentc802bc1e792a35f5a89a97aedd353f1ff4972a5e (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: I5513595f06b2537b1700fa1e0fb4b28b38eccaad Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
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|