X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fetc%2Fconf.py;h=d10868de5bf3ffa45dac7a739215c83388880102;hb=f98556c6d6f201d14ec3f3484cbdcd27e22fd56f;hp=486983f198686ec8db0c0699c32f71020b662f6d;hpb=d4b56fae1f6760e22f11ca1b3be0230a1074867a;p=releng.git

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
index 486983f19..d10868de5 100644
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
@@ -1,34 +1,29 @@
-import datetime
-import sys
-import os
+'''
+Base configuration file for building OPNFV docs
 
-try:
-    __import__('imp').find_module('sphinx.ext.numfig')
-    extensions = ['sphinx.ext.numfig']
-except ImportError:
-    # 'pip install sphinx_numfig'
-    extensions = ['sphinx_numfig']
+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:
-number_figures = True
-figure_caption_prefix = "Fig."
+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.
 
-source_suffix = '.rst'
+For further guidance see the https://wiki.opnfv.org/documentation/tools page.
+'''
+
+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'
\ No newline at end of file
+latex_domain_indices = False
+latex_logo = 'opnfv-logo.png'