diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2016-03-31 15:41:11 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2016-03-31 15:41:11 -0400 |
| commit | b177ac85ca0d0bdeac4b6e37847b341b0b568f47 (patch) | |
| tree | ea810082f0a1cbe70a840cd087433590dcdb3e96 /docs/how-to-use-docs/index.rst | |
| parent | 7e89895d701f4b253a9d91cb98e15d3f00c4ef7b (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, these files are only meant as place holders
and should be replaced by your own project documentation
Change-Id: I3c61ef2dac43d55f4cf6c6677099fef8b101a182
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 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| |