doc/bindings/python/source/conf.py

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