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/etc | |
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/etc')
-rw-r--r-- | docs/etc/conf.py | 34 | ||||
-rw-r--r-- | docs/etc/opnfv-logo.png | bin | 0 -> 2829 bytes |
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py new file mode 100644 index 0000000..0066035 --- /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 0000000..1519503 --- /dev/null +++ b/docs/etc/opnfv-logo.png |