diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2015-09-10 15:31:04 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2015-09-10 15:31:12 -0400 |
| commit | 1e12bc16fa839ab0bfd1ec1e57a11143bc979bb6 (patch) | |
| tree | fc379bbdfd2e392e8071637d8bc1b9a6caecd1ca /docs/how-to-use-docs/index.rst | |
| parent | 2e1a0e87cca17e4d44285b2ed6cd78a6fad8811c (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: Ie6ca71ca282b6fff43626b8f00b1a38f714f1097
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| |