summaryrefslogtreecommitdiffstats
path: root/docs/development/requirements/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'docs/development/requirements/conf.py')
-rw-r--r--docs/development/requirements/conf.py55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/development/requirements/conf.py b/docs/development/requirements/conf.py
new file mode 100644
index 0000000..9912324
--- /dev/null
+++ b/docs/development/requirements/conf.py
@@ -0,0 +1,55 @@
+# Copyright 2016 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 NetReady requirements
+# documentation based on the configuration file used by the Copper project.
+#
+
+import datetime
+import sys
+import os
+import subprocess
+
+try:
+ __import__('imp').find_module('sphinx.ext.numfig')
+ extensions = ['sphinx.ext.numfig']
+except ImportError:
+ # 'pip install sphinx_numfig'
+ extensions = ['sphinx_numfig']
+
+try:
+ __import__('imp').find_module('sphinxcontrib-fulltoc')
+except ImportError:
+ subprocess.call("pip install sphinxcontrib-fulltoc", shell=True)
+extensions.append('sphinxcontrib-fulltoc')
+
+# numfig:
+number_figures = True
+figure_caption_prefix = "Fig."
+
+source_suffix = '.rst'
+master_doc = 'index'
+pygments_style = 'sphinx'
+html_use_index = True
+html_theme = 'sphinx_rtd_theme'
+
+pdf_documents = [('index', u'OPNFV', u'OPNFV NetReady Project', u'OPNFV')]
+pdf_fit_mode = "shrink"
+pdf_stylesheets = ['sphinx','kerning','a4']
+#latex_domain_indices = False
+#latex_use_modindex = False
+
+latex_elements = {
+ 'printindex': '',
+}