summaryrefslogtreecommitdiffstats
path: root/docs/etc
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2015-10-07 15:13:13 -0400
committerAric Gardner <agardner@linuxfoundation.org>2015-10-07 15:13:13 -0400
commitecb3d9d318e10a154de2c028839c0617274a04cd (patch)
treee4df941405ecddd51387e2005329b67d1a108e48 /docs/etc
parent469e17a834ca47e4f27e32f4541d468cb2fe0eca (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: Ifd69406c3284eecd0d549ddf1d83f4599ea8befb JIRA:RELENG-15 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs/etc')
-rw-r--r--docs/etc/conf.py34
-rw-r--r--docs/etc/opnfv-logo.pngbin0 -> 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
new file mode 100644
index 0000000..1519503
--- /dev/null
+++ b/docs/etc/opnfv-logo.png
Binary files differ