docs/etc/conf.py

   1 # Licensed under the Apache License, Version 2.0 (the "License");
   2 # you may not use this file except in compliance with the License.
   3 # You may obtain a copy of the License at
   4 #
   5 #    http://www.apache.org/licenses/LICENSE-2.0
   6 #
   7 # Unless required by applicable law or agreed to in writing, software
   8 # distributed under the License is distributed on an "AS IS" BASIS,
   9 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  10 # implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14
  15 import datetime
  16
  17 try:
  18     __import__('imp').find_module('sphinx.ext.numfig')
  19     extensions = ['sphinx.ext.numfig']
  20 except ImportError:
  21     # 'pip install sphinx_numfig'
  22     extensions = ['sphinx_numfig']
  23
  24 # numfig:
  25 number_figures = True
  26 figure_caption_prefix = "Fig."
  27
  28 source_suffix = '.rst'
  29 master_doc = 'index'
  30 pygments_style = 'sphinx'
  31 html_use_index = False
  32
  33 pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')]
  34 pdf_fit_mode = "shrink"
  35 pdf_stylesheets = ['sphinx', 'kerning', 'a4']
  36
  37 latex_elements = {
  38     'printindex': '',
  39 }
  40
  41 project = u'OPNFV: Template documentation config'
  42 copyright = u'%s, OPNFV' % datetime.date.today().year
  43 version = u'1.0.0'
  44 release = u'1.0.0'