From 3329cf08d900f633267151110a71464ed9d9cd8e Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Thu, 10 Sep 2015 15:32:27 -0400 Subject: 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: If69afd1c688be2fd4d7d6a417f0362801558abcb JIRA:RELENG-15 Signed-off-by: Aric Gardner --- docs/how-to-use-docs/index.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/how-to-use-docs/index.rst (limited to 'docs/how-to-use-docs/index.rst') 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| -- cgit 1.2.3-korg