doc: update template and conf files

JIRA: RELENG-16

Change-Id: I0aaac15c1d1a1031cbc113db594a342c60b7eb1d
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

diff --git a/docs/design/index.rst b/docs/design/index.rst
index f5d2cc5..c93d671 100755 (executable)
--- a/docs/design/index.rst
+++ b/docs/design/index.rst
@@ -1,18 +1,6 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
+=============
 VSPERF Design
-=======================================
-
-Contents:
+=============
 
 .. toctree::
    :numbered:
@@ -20,8 +8,6 @@ Contents:
 
    vswitchperf_design.rst
 
-* :ref:`search`
-
 Revision: _sha1_
 
 Build date: |today|

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
index 0066035..f42b110 100644 (file)
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
@@ -1,34 +1,27 @@
-import datetime
-import sys
-import os
+'''
+Base configuration file for sphinx-build.
 
-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. 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.
+'''
 
-# numfig:
-number_figures = True
-figure_caption_prefix = "Fig."
+import datetime
 
-source_suffix = '.rst'
+needs_sphinx = '1.3'
 master_doc = 'index'
 pygments_style = 'sphinx'
-html_use_index = False
 
-pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')]
-pdf_fit_mode = "shrink"
-pdf_stylesheets = ['sphinx','kerning','a4']
-#latex_domain_indices = False
-#latex_use_modindex = False
+html_use_index = False
+numfig = True
+html_logo = 'opnfv-logo.png'
 
-latex_elements = {
-    'printindex': '',
-}
+latex_elements = {'printindex': ''}
+latex_logo = 'opnfv-logo.png'
 
-project = u'OPNFV: Template documentation config'
 copyright = u'%s, OPNFV' % datetime.date.today().year
 version = u'1.0.0'
 release = u'1.0.0'

diff --git a/docs/guides/index.rst b/docs/guides/index.rst
index c2b197d..bf049fb 100755 (executable)
--- a/docs/guides/index.rst
+++ b/docs/guides/index.rst
@@ -1,18 +1,6 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
+==============================
 VSPERF Guides and Installation
-========================================
-
-Contents:
+==============================
 
 .. toctree::
    :numbered:
@@ -21,8 +9,6 @@ Contents:
    quickstart.rst
    installation.rst
 
-* :ref:`search`
-
 Revision: _sha1_
 
 Build date: |today|

diff --git a/docs/index.rst b/docs/index.rst
index bb0a698..ec5176c 100755 (executable)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,18 +1,6 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
+======
 VSPERF
-=======================================
-
-Contents:
+======
 
 .. toctree::
    :maxdepth: 4
@@ -23,8 +11,6 @@ Contents:
    test_spec/index
    updates/index
 
-* :ref:`search`
-
 Revision: _sha1_
 
 Build date: |today|

diff --git a/docs/test_spec/index.rst b/docs/test_spec/index.rst
index 1ae1669..e36b7d8 100755 (executable)
--- a/docs/test_spec/index.rst
+++ b/docs/test_spec/index.rst
@@ -1,18 +1,6 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
+=========================
 VSPERF Test Specification
-=======================================
-
-Contents:
+=========================
 
 .. toctree::
    :numbered:
@@ -24,8 +12,6 @@ Contents:
    vswitchperf_ltd.rst
    vswitchperf_design.rst
 
-* :ref:`search`
-
 Revision: _sha1_
 
 Build date: |today|

diff --git a/docs/updates/index.rst b/docs/updates/index.rst
index 9d1e47e..6e26162 100755 (executable)
--- a/docs/updates/index.rst
+++ b/docs/updates/index.rst
@@ -1,18 +1,6 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
+===========
 VSPERF News
-=======================================
-
-Contents:
+===========
 
 .. toctree::
    :numbered:
@@ -20,8 +8,6 @@ Contents:
 
    NEWS.rst
 
-* :ref:`search`
-
 Revision: _sha1_
 
 Build date: |today|