summaryrefslogtreecommitdiffstats
path: root/docs/etc/conf.py
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2015-09-10 15:40:56 -0400
committerAric Gardner <agardner@linuxfoundation.org>2015-09-10 15:41:05 -0400
commit4e63eda834fbaee8e910f2cb0f6ca3ca84709445 (patch)
treee5d8e650915260e51b837cbffac23969717021f9 /docs/etc/conf.py
parent5a746b80d76d53bff63e4dac735c6bee4e8114c0 (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 Change-Id: I084e0af553c9f7e503fb55a3dd4990edbcf3394d JIRA:RELENG-15 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
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 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'