diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2015-09-10 15:32:39 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2015-09-10 15:32:47 -0400 |
| commit | 5599663fc5638efdcabc8407a98b54cf5373934f (patch) | |
| tree | 577e80461b6a593b14edd8a7908fc0940b6ea96b /docs/how-to-use-docs/index.rst | |
| parent | 1f19380b5f5d34c4f74634de3b90f5b2b3edea1b (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: I2efd151fb176ff5d94a7f97063c66bdb3cbb58a0
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.rst | 30 |
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 00000000..36710b32 --- /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| |