From db0e8d31d9e9e4c3f422d5bae061239f336180e2 Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Thu, 10 Sep 2015 15:32:02 -0400 Subject: 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: I24007a0386251cee4325cea49f78f8f021de5276 JIRA:RELENG-15 Signed-off-by: Aric Gardner --- docs/etc/conf.py | 34 ++++++++++++++++++++++++++++++++++ docs/etc/opnfv-logo.png | Bin 0 -> 2829 bytes 2 files changed, 34 insertions(+) create mode 100644 docs/etc/conf.py create mode 100644 docs/etc/opnfv-logo.png (limited to 'docs/etc') diff --git a/docs/etc/conf.py b/docs/etc/conf.py new file mode 100644 index 00000000..00660351 --- /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 new file mode 100644 index 00000000..1519503e Binary files /dev/null and b/docs/etc/opnfv-logo.png differ -- cgit 1.2.3-korg