docs/etc/conf.py

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