aboutsummaryrefslogtreecommitdiffstats
path: root/docs/etc/conf.py
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2015-09-11 15:45:39 -0400
committerAric Gardner <agardner@linuxfoundation.org>2015-09-11 15:45:39 -0400
commit081ace7342b175f8e06d8aa9848e2aa4557f65c8 (patch)
treed04866bd42a73bbe58faa873b72121476b8c31f2 /docs/etc/conf.py
parent72a6363bacadab1a0565ce71144471ba6f6d64ae (diff)
Move documentation to new sphinx build
TODO: Reorganize documentation into properly named subfolders TODO: Add logos to documentation (see index.rst for example) Note you can see the results of this change via a link in the gerrit comments below NOTE: The merge job for your project has not been enabled, this code will not go to the artifacts page upon a merge. you can merge it and work on it in your own time, please contact me to enable the merge (the merge job will make this documentation avaliable to the public on artifacts.opnfv.org) JIRA:RELENG-15 Change-Id: I3f3d8c9d7fceae90e0ed824b66bdaf7a8ea66328 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 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'