summaryrefslogtreecommitdiffstats
path: root/docs/development/design/conf.py
diff options
context:
space:
mode:
authorAimee Ukasick <aimeeu.opensource@gmail.com>2017-02-07 13:23:37 -0600
committerAimee Ukasick <aimeeu.opensource@gmail.com>2017-02-07 13:23:37 -0600
commit572ce78c886cf49bd617a2ff3d96491b22a66f88 (patch)
treed32e4c9d727ece871ec89f1d47005756ddc2b3c7 /docs/development/design/conf.py
parentc04ffff59b770ae32c4691bdc3d3b4363604db78 (diff)
Updated to use new docs structure WIP
JIRA: COPPER-1 WIP - not sure how to fill in the docs/release/scenarios section Change-Id: I8684e4647e7b943ca05dc77131a54338ff932b78 Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Diffstat (limited to 'docs/development/design/conf.py')
-rw-r--r--docs/development/design/conf.py50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/development/design/conf.py b/docs/development/design/conf.py
new file mode 100644
index 0000000..99b1ca2
--- /dev/null
+++ b/docs/development/design/conf.py
@@ -0,0 +1,50 @@
+# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# What this is: Configuration file for OPNFV Copper project documentation
+# generation via Sphinx.
+#
+# Status: Tested and used in production of Copper project documentation.
+#
+
+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
+html_theme = 'sphinx_rtd_theme'
+
+pdf_documents = [('index', u'OPNFV', u'OPNFV Copper Project', u'OPNFV')]
+pdf_fit_mode = "shrink"
+pdf_stylesheets = ['sphinx','kerning','a4']
+#latex_domain_indices = False
+#latex_use_modindex = False
+
+latex_elements = {
+ 'printindex': '',
+}