diff options
author | Aric Gardner <agardner@linuxfoundation.org> | 2015-10-07 15:13:13 -0400 |
---|---|---|
committer | Aric Gardner <agardner@linuxfoundation.org> | 2015-10-07 15:13:13 -0400 |
commit | ecb3d9d318e10a154de2c028839c0617274a04cd (patch) | |
tree | e4df941405ecddd51387e2005329b67d1a108e48 /docs/how-to-use-docs/index.rst | |
parent | 469e17a834ca47e4f27e32f4541d468cb2fe0eca (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: Ifd69406c3284eecd0d549ddf1d83f4599ea8befb
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| |