diff options
author | Ryota MIBU <r-mibu@cq.jp.nec.com> | 2015-11-26 20:36:01 +0900 |
---|---|---|
committer | Ryota MIBU <r-mibu@cq.jp.nec.com> | 2015-11-26 20:37:41 +0900 |
commit | 8c1f9914fd40b240171a0c165999d10771320431 (patch) | |
tree | 7ba79e5d267dae0f226e31777a7141c9a3fe8630 /docs/etc/conf.py | |
parent | 41534201310f2ea651aa9ac988ec9e18b9d92567 (diff) |
doc: update template and conf files
JIRA: RELENG-16
Change-Id: I0aaac15c1d1a1031cbc113db594a342c60b7eb1d
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Diffstat (limited to 'docs/etc/conf.py')
-rw-r--r-- | docs/etc/conf.py | 39 |
1 files changed, 16 insertions, 23 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py index 00660351..f42b1105 100644 --- 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' |