doc/bindings/python/source/conf.py

   1 #!/usr/bin/env python3
   2 # -*- coding: utf-8 -*-
   3 import babeltrace
   4 import os
   5
   6
   7 # general configuration
   8 needs_sphinx = '1.2'
   9 extensions = [
  10     'sphinx.ext.autodoc',
  11     'sphinx.ext.ifconfig',
  12 ]
  13 templates_path = ['_templates']
  14 source_suffix = '.rst'
  15 source_encoding = 'utf-8-sig'
  16 master_doc = 'index'
  17 project = 'Babeltrace Python bindings'
  18 copyright = '2014, EfficiOS Inc.'
  19 version = babeltrace.__version__
  20 release = version
  21 language = None
  22 today = ''
  23 today_fmt = '%B %d, %Y'
  24 exclude_patterns = []
  25 default_role = None
  26 add_function_parentheses = True
  27 add_module_names = True
  28 show_authors = False
  29 pygments_style = 'sphinx'
  30 modindex_common_prefix = []
  31 keep_warnings = False
  32
  33 # HTML output options
  34 html_theme = 'default'
  35
  36 if os.path.isdir(os.path.join('_themes', 'sphinx_rtd_theme')):
  37     html_theme = 'sphinx_rtd_theme'
  38
  39 html_theme_options = {}
  40 html_theme_path = ['_themes']
  41 html_title = None
  42 html_short_title = None
  43 html_logo = None
  44 html_favicon = None
  45 html_static_path = ['_static']
  46 html_extra_path = []
  47 html_last_updated_fmt = '%b %d, %Y'
  48 html_use_smartypants = False
  49 html_sidebars = {}
  50 html_additional_pages = {}
  51 html_domain_indices = True
  52 html_use_index = True
  53 html_split_index = False
  54 html_show_sourcelink = False
  55 html_show_copyright = True
  56 htmlhelp_basename = 'BabeltracePydoc'