Doc/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Python documentation build configuration file
   4 #
   5 # This file is execfile()d with the current directory set to its containing dir.
   6 #
   7 # The contents of this file are pickled, so don't put values in the namespace
   8 # that aren't pickleable (module imports are okay, they're removed automatically).
   9
  10 import sys, os, time
  11 sys.path.append(os.path.abspath('tools/sphinxext'))
  12
  13 # General configuration
  14 # ---------------------
  15
  16 extensions = ['sphinx.ext.refcounting', 'sphinx.ext.coverage',
  17               'sphinx.ext.doctest', 'pyspecific']
  18 templates_path = ['tools/sphinxext']
  19
  20 # General substitutions.
  21 project = 'Python'
  22 copyright = '1990-%s, Python Software Foundation' % time.strftime('%Y')
  23
  24 # The default replacements for |version| and |release|.
  25 #
  26 # The short X.Y version.
  27 # version = '2.6'
  28 # The full version, including alpha/beta/rc tags.
  29 # release = '2.6a0'
  30
  31 # We look for the Include/patchlevel.h file in the current Python source tree
  32 # and replace the values accordingly.
  33 import patchlevel
  34 version, release = patchlevel.get_version_info()
  35
  36 # There are two options for replacing |today|: either, you set today to some
  37 # non-false value, then it is used:
  38 today = ''
  39 # Else, today_fmt is used as the format for a strftime call.
  40 today_fmt = '%B %d, %Y'
  41
  42 # List of files that shouldn't be included in the build.
  43 unused_docs = [
  44     'maclib/scrap',
  45     'library/xmllib',
  46     'library/xml.etree',
  47 ]
  48
  49 # Ignore .rst in Sphinx its self.
  50 exclude_trees = ['tools/sphinx']
  51
  52 # Relative filename of the reference count data file.
  53 refcount_file = 'data/refcounts.dat'
  54
  55 # If true, '()' will be appended to :func: etc. cross-reference text.
  56 add_function_parentheses = True
  57
  58 # If true, the current module name will be prepended to all description
  59 # unit titles (such as .. function::).
  60 add_module_names = True
  61
  62 # By default, highlight as Python 3.
  63 highlight_language = 'python3'
  64
  65
  66 # Options for HTML output
  67 # -----------------------
  68
  69 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  70 # using the given strftime format.
  71 html_last_updated_fmt = '%b %d, %Y'
  72
  73 # If true, SmartyPants will be used to convert quotes and dashes to
  74 # typographically correct entities.
  75 html_use_smartypants = True
  76
  77 # Custom sidebar templates, filenames relative to this file.
  78 html_sidebars = {
  79     'index': 'indexsidebar.html',
  80 }
  81
  82 # Additional templates that should be rendered to pages.
  83 html_additional_pages = {
  84     'download': 'download.html',
  85     'index': 'indexcontent.html',
  86 }
  87
  88 # Output an OpenSearch description file.
  89 html_use_opensearch = 'http://docs.python.org/dev/3.0'
  90
  91 # Additional static files.
  92 html_static_path = ['tools/sphinxext/static']
  93
  94 # Output file base name for HTML help builder.
  95 htmlhelp_basename = 'python' + release.replace('.', '')
  96
  97 # Split the index
  98 html_split_index = True
  99
 100
 101 # Options for LaTeX output
 102 # ------------------------
 103
 104 # The paper size ('letter' or 'a4').
 105 latex_paper_size = 'a4'
 106
 107 # The font size ('10pt', '11pt' or '12pt').
 108 latex_font_size = '10pt'
 109
 110 # Grouping the document tree into LaTeX files. List of tuples
 111 # (source start file, target name, title, author, document class [howto/manual]).
 112 _stdauthor = r'Guido van Rossum\\Fred L. Drake, Jr., editor'
 113 latex_documents = [
 114     ('c-api/index', 'c-api.tex',
 115      'The Python/C API', _stdauthor, 'manual'),
 116     ('distutils/index', 'distutils.tex',
 117      'Distributing Python Modules', _stdauthor, 'manual'),
 118     ('documenting/index', 'documenting.tex',
 119      'Documenting Python', 'Georg Brandl', 'manual'),
 120     ('extending/index', 'extending.tex',
 121      'Extending and Embedding Python', _stdauthor, 'manual'),
 122     ('install/index', 'install.tex',
 123      'Installing Python Modules', _stdauthor, 'manual'),
 124     ('library/index', 'library.tex',
 125      'The Python Library Reference', _stdauthor, 'manual'),
 126     ('reference/index', 'reference.tex',
 127      'The Python Language Reference', _stdauthor, 'manual'),
 128     ('tutorial/index', 'tutorial.tex',
 129      'Python Tutorial', _stdauthor, 'manual'),
 130     ('using/index', 'using.tex',
 131      'Using Python', _stdauthor, 'manual'),
 132     ('whatsnew/' + version, 'whatsnew.tex',
 133      'What\'s New in Python', 'A. M. Kuchling', 'howto'),
 134 ]
 135 # Collect all HOWTOs individually
 136 latex_documents.extend(('howto/' + fn[:-4], 'howto-' + fn[:-4] + '.tex',
 137                         '', _stdauthor, 'howto')
 138                        for fn in os.listdir('howto')
 139                        if fn.endswith('.rst') and fn != 'index.rst')
 140
 141 # Additional stuff for the LaTeX preamble.
 142 latex_preamble = r'''
 143 \authoraddress{
 144   \strong{Python Software Foundation}\\
 145   Email: \email{docs@python.org}
 146 }
 147 \let\Verbatim=\OriginalVerbatim
 148 \let\endVerbatim=\endOriginalVerbatim
 149 '''
 150
 151 # Documents to append as an appendix to all manuals.
 152 latex_appendices = ['glossary', 'about', 'license', 'copyright']
 153
 154 # Options for the coverage checker
 155 # --------------------------------
 156
 157 # The coverage checker will ignore all modules/functions/classes whose names
 158 # match any of the following regexes (using re.match).
 159 coverage_ignore_modules = [
 160     r'[T|t][k|K]',
 161     r'Tix',
 162     r'distutils.*',
 163 ]
 164
 165 coverage_ignore_functions = [
 166     'test($|_)',
 167 ]
 168
 169 coverage_ignore_classes = [
 170 ]
 171
 172 # Glob patterns for C source files for C API coverage, relative to this directory.
 173 coverage_c_path = [
 174     '../Include/*.h',
 175 ]
 176
 177 # Regexes to find C items in the source files.
 178 coverage_c_regexes = {
 179     'cfunction': (r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'),
 180     'data': (r'^PyAPI_DATA\(.*\)\s+([^_][\w_]+)'),
 181     'macro': (r'^#define ([^_][\w_]+)\(.*\)[\s|\\]'),
 182 }
 183
 184 # The coverage checker will ignore all C items whose names match these regexes
 185 # (using re.match) -- the keys must be the same as in coverage_c_regexes.
 186 coverage_ignore_c_items = {
 187 #    'cfunction': [...]
 188 }