Merge "QTIP OPNFV Docker Build issue fix"

[releng.git] / docs / etc / conf.py

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
index 6719653..d10868d 100644 (file)
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
@@ -1,27 +1,29 @@
-import datetime
-import sys
-import os
+'''
+Base configuration file for building OPNFV docs
 
-needs_sphinx = '1.3'
+You can override this configuration by putting 'conf.py' in the document
+directory (e.g. docs/how-to-use-docs/conf.py). If there is no 'conf.py'
+in the document directory, this file will be copied to that directory
+before the document builder jobs ('opnfv-docs-verify' and 'opnfv-docs-merge').
 
-numfig = True
+You may need python package installation for new sphinx extension.
+Install python package with 'pip' in your machine and add the extension to
+the 'extensions' list below to test the documentation build locally.
+If you feel that your extensions would be useful for other projects too,
+we encourage you to propose a change in the releng repository.
+
+For further guidance see the https://wiki.opnfv.org/documentation/tools page.
+'''
 
-source_suffix = '.rst'
+extensions = ['sphinxcontrib.httpdomain']
+
+needs_sphinx = '1.3'
 master_doc = 'index'
 pygments_style = 'sphinx'
-html_use_index = False
-
-pdf_documents = [('index', u'Copper', u'Copper Project', u'OPNFV')]
-pdf_fit_mode = "shrink"
-pdf_stylesheets = ['sphinx','kerning','a4']
-#latex_domain_indices = False
-#latex_use_modindex = False
 
-latex_elements = {
-    'printindex': '',
-}
+html_use_index = False
+numfig = True
+html_logo = 'opnfv-logo.png'
 
-project = u'Copper: Virtual Infrastructure Deployment Policies'
-copyright = u'%s, OPNFV' % datetime.date.today().year
-version = u'1.0.0'
-release = u'1.0.0'
+latex_domain_indices = False
+latex_logo = 'opnfv-logo.png'