diff options
-rw-r--r-- | docs/etc/conf.py | 34 | ||||
-rw-r--r-- | docs/etc/opnfv-logo.png | bin | 0 -> 2829 bytes | |||
-rwxr-xr-x | docs/to-be-reorganized/Yardstick_task_templates.rst (renamed from docs/Yardstick_task_templates.rst) | 0 | ||||
-rw-r--r-- | docs/to-be-reorganized/index.rst | 31 | ||||
-rw-r--r-- | docs/to-be-reorganized/testcase_description_template.rst (renamed from docs/templates/testcase_description_template.rst) | 0 |
5 files changed, 65 insertions, 0 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py new file mode 100644 index 000000000..006603516 --- /dev/null +++ b/docs/etc/conf.py @@ -0,0 +1,34 @@ +import datetime +import sys +import os + +try: + __import__('imp').find_module('sphinx.ext.numfig') + extensions = ['sphinx.ext.numfig'] +except ImportError: + # 'pip install sphinx_numfig' + extensions = ['sphinx_numfig'] + +# numfig: +number_figures = True +figure_caption_prefix = "Fig." + +source_suffix = '.rst' +master_doc = 'index' +pygments_style = 'sphinx' +html_use_index = False + +pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] +pdf_fit_mode = "shrink" +pdf_stylesheets = ['sphinx','kerning','a4'] +#latex_domain_indices = False +#latex_use_modindex = False + +latex_elements = { + 'printindex': '', +} + +project = u'OPNFV: Template documentation config' +copyright = u'%s, OPNFV' % datetime.date.today().year +version = u'1.0.0' +release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png Binary files differnew file mode 100644 index 000000000..1519503eb --- /dev/null +++ b/docs/etc/opnfv-logo.png diff --git a/docs/Yardstick_task_templates.rst b/docs/to-be-reorganized/Yardstick_task_templates.rst index 538937fd7..538937fd7 100755 --- a/docs/Yardstick_task_templates.rst +++ b/docs/to-be-reorganized/Yardstick_task_templates.rst diff --git a/docs/to-be-reorganized/index.rst b/docs/to-be-reorganized/index.rst new file mode 100644 index 000000000..5e078d2c7 --- /dev/null +++ b/docs/to-be-reorganized/index.rst @@ -0,0 +1,31 @@ +.. 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 + + Yardstick_task_templates.rst + testcase_description_template.rst + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/templates/testcase_description_template.rst b/docs/to-be-reorganized/testcase_description_template.rst index 899554dec..899554dec 100644 --- a/docs/templates/testcase_description_template.rst +++ b/docs/to-be-reorganized/testcase_description_template.rst |