summaryrefslogtreecommitdiffstats
path: root/docs/etc/conf.py
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2016-01-15 21:08:57 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-01-15 21:08:58 +0000
commit84566653e559db9bd36021273b36577bb39d05f4 (patch)
treef830bd113b8525ff89e494e7899d75099a21a495 /docs/etc/conf.py
parente6a7d12173d9304ec81584b224ccc2ae5dc51985 (diff)
parent4422d1d6812da14497eaa47393899d08909d09b8 (diff)
Merge "Example as code, documentation template for sphinx build"
Diffstat (limited to 'docs/etc/conf.py')
-rw-r--r--docs/etc/conf.py34
1 files changed, 34 insertions, 0 deletions
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'