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     'whatsnew/2.0',
  45     'whatsnew/2.1',
  46     'whatsnew/2.2',
  47     'whatsnew/2.3',
  48     'whatsnew/2.4',
  49     'whatsnew/2.5',
  50     'maclib/scrap',
  51     'library/xmllib',
  52     'library/xml.etree',
  53 ]
  54
  55 # Relative filename of the reference count data file.
  56 refcount_file = 'data/refcounts.dat'
  57
  58 # If true, '()' will be appended to :func: etc. cross-reference text.
  59 add_function_parentheses = True
  60
  61 # If true, the current module name will be prepended to all description
  62 # unit titles (such as .. function::).
  63 add_module_names = True
  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'
  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
  98 # Options for LaTeX output
  99 # ------------------------
 100
 101 # The paper size ('letter' or 'a4').
 102 latex_paper_size = 'a4'
 103
 104 # The font size ('10pt', '11pt' or '12pt').
 105 latex_font_size = '10pt'
 106
 107 # Grouping the document tree into LaTeX files. List of tuples
 108 # (source start file, target name, title, author, document class [howto/manual]).
 109 _stdauthor = r'Guido van Rossum\\Fred L. Drake, Jr., editor'
 110 latex_documents = [
 111     ('c-api/index', 'c-api.tex',
 112      'The Python/C API', _stdauthor, 'manual'),
 113     ('distutils/index', 'distutils.tex',
 114      'Distributing Python Modules', _stdauthor, 'manual'),
 115     ('documenting/index', 'documenting.tex',
 116      'Documenting Python', 'Georg Brandl', 'manual'),
 117     ('extending/index', 'extending.tex',
 118      'Extending and Embedding Python', _stdauthor, 'manual'),
 119     ('install/index', 'install.tex',
 120      'Installing Python Modules', _stdauthor, 'manual'),
 121     ('library/index', 'library.tex',
 122      'The Python Library Reference', _stdauthor, 'manual'),
 123     ('reference/index', 'reference.tex',
 124      'The Python Language Reference', _stdauthor, 'manual'),
 125     ('tutorial/index', 'tutorial.tex',
 126      'Python Tutorial', _stdauthor, 'manual'),
 127     ('using/index', 'using.tex',
 128      'Using Python', _stdauthor, 'manual'),
 129     ('whatsnew/' + version, 'whatsnew.tex',
 130      'What\'s New in Python', 'A. M. Kuchling', 'howto'),
 131 ]
 132 # Collect all HOWTOs individually
 133 latex_documents.extend(('howto/' + fn[:-4], 'howto-' + fn[:-4] + '.tex',
 134                         'HOWTO', _stdauthor, 'howto')
 135                        for fn in os.listdir('howto')
 136                        if fn.endswith('.rst') and fn != 'index.rst')
 137
 138 # Additional stuff for the LaTeX preamble.
 139 latex_preamble = r'''
 140 \authoraddress{
 141   \strong{Python Software Foundation}\\
 142   Email: \email{docs@python.org}
 143 }
 144 '''
 145
 146 # Documents to append as an appendix to all manuals.
 147 latex_appendices = ['glossary', 'about', 'license', 'copyright']
 148
 149 # Options for the coverage checker
 150 # --------------------------------
 151
 152 # The coverage checker will ignore all modules/functions/classes whose names
 153 # match any of the following regexes (using re.match).
 154 coverage_ignore_modules = [
 155     r'[T|t][k|K]',
 156     r'Tix',
 157     r'distutils.*',
 158 ]
 159
 160 coverage_ignore_functions = [
 161     'test($|_)',
 162 ]
 163
 164 coverage_ignore_classes = [
 165 ]
 166
 167 # Glob patterns for C source files for C API coverage, relative to this directory.
 168 coverage_c_path = [
 169     '../Include/*.h',
 170 ]
 171
 172 # Regexes to find C items in the source files.
 173 coverage_c_regexes = {
 174     'cfunction': (r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'),
 175     'data': (r'^PyAPI_DATA\(.*\)\s+([^_][\w_]+)'),
 176     'macro': (r'^#define ([^_][\w_]+)\(.*\)[\s|\\]'),
 177 }
 178
 179 # The coverage checker will ignore all C items whose names match these regexes
 180 # (using re.match) -- the keys must be the same as in coverage_c_regexes.
 181 coverage_ignore_c_items = {
 182 #    'cfunction': [...]
 183 }