Add location of pod config files into slave-config & disable lab-reconfig

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

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
index f42b110..d10868d 100644 (file)
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
@@ -1,15 +1,21 @@
 '''
-Base configuration file for sphinx-build.
+Base configuration file for building OPNFV docs
 
 You can override this configuration by putting 'conf.py' in the document
-directory (e.g. 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 in 'opnfv-docs-verify' and 'opnfv-docs-merge'.
-The logo image (opnfv-logo.png) will be also copied from
-docs/etc/opnfv-logo.png during the build jobs.
+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').
+
+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.
 '''
 
-import datetime
+extensions = ['sphinxcontrib.httpdomain']
 
 needs_sphinx = '1.3'
 master_doc = 'index'
@@ -19,9 +25,5 @@ html_use_index = False
 numfig = True
 html_logo = 'opnfv-logo.png'
 
-latex_elements = {'printindex': ''}
+latex_domain_indices = False
 latex_logo = 'opnfv-logo.png'
-
-copyright = u'%s, OPNFV' % datetime.date.today().year
-version = u'1.0.0'
-release = u'1.0.0'