sphinx / doc /

georg.brandl 186cf92 

Georg Brandl b3c383c 
georg.brandl 186cf92 
Georg Brandl b9c18e6 

georg.brandl 186cf92 
pv 3ad0dfe 
Georg Brandl 1a96e87 
georg.brandl 186cf92 
Georg Brandl b9c18e6 
georg.brandl a8dd86c 
Georg Brandl 5463dcc 
georg.brandl 186cf92 

Georg Brandl b43795a 
georg.brandl 67f87d5 
georg.brandl dd0d33d 
georg.brandl 186cf92 

Georg Brandl f7c28ed 
mq 0e4cfbf 
georg.brandl a8dd86c 
georg.brandl 186cf92 
Georg Brandl ebe4c7c 
georg.brandl 8b762e4 
georg.brandl 34c75fb 
georg.brandl 912c852 
georg.brandl 186cf92 

Georg Brandl 6ac1f33 
Roland Meister 6422ce7 
Georg Brandl 6ac1f33 
Roland Meister 6422ce7 

Roland Meister 4920afb 
Roland Meister 6422ce7 
Roland Meister 52e2edd 
Roland Meister 6422ce7 

georg.brandl 186cf92 
Georg Brandl 70d8841 
georg.brandl 2531f8f 
georg.brandl f7434f9 
Georg Brandl 5b1718f 
georg.brandl f7434f9 
georg.brandl 186cf92 
Georg Brandl b69ed14 
Georg Brandl 99e97f4 
Georg Brandl 680185c 

Georg Brandl b43795a 
Georg Brandl 2ffdb09 

Georg Brandl 6b12eb8 

Georg Brandl 2ffdb09 
Georg Brandl 99e97f4 
Georg Brandl 0ac6246 

Georg Brandl 99e97f4 
Georg Brandl b3c383c 
georg.brandl a2afdae 

georg.brandl c604e42 

georg.brandl a2afdae 
georg.brandl 5d253be 

Georg Brandl def6a37 
Georg Brandl 68d3dc0 

georg.brandl c604e42 
# -*- coding: utf-8 -*-
# Sphinx documentation build configuration file

import re
import sphinx

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
              'sphinx.ext.autosummary', 'sphinx.ext.extlinks']

master_doc = 'contents'
templates_path = ['_templates']
exclude_patterns = ['_build']

project = 'Sphinx'
copyright = '2007-2010, Georg Brandl'
version = sphinx.__released__
release = version
show_authors = True

html_theme = 'sphinxdoc'
modindex_common_prefix = ['sphinx.']
html_static_path = ['_static']
html_index = 'index.html'
html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}
html_additional_pages = {'index': 'index.html'}
html_use_opensearch = ''

htmlhelp_basename = 'Sphinxdoc'

epub_theme = 'epub'
epub_basename = 'sphinx'
epub_author = 'Georg Brandl'
epub_publisher = ''
epub_scheme = 'url'
epub_identifier = epub_publisher
epub_pre_files = [('index.html', 'Welcome')]
epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js',
    '_static/jquery.js', '_static/searchtools.js', '_static/underscore.js',
    '_static/basic.css', 'search.html']

latex_documents = [('contents', 'sphinx.tex', 'Sphinx Documentation',
                    'Georg Brandl', 'manual', 1)]
latex_logo = '_static/sphinx.png'
latex_elements = {
    'fontpkg': '\\usepackage{palatino}',

autodoc_member_order = 'groupwise'
todo_include_todos = True
extlinks = {'duref': (''
                      'restructuredtext.html#%s', ''),
            'durole': (''
                       'roles.html#%s', ''),
            'dudir': (''
                      'directives.html#%s', '')}

man_pages = [
    ('contents', 'sphinx-all', 'Sphinx documentation generator system manual',
     'Georg Brandl', 1),
    ('man/sphinx-build', 'sphinx-build', 'Sphinx documentation generator tool',
     '', 1),
    ('man/sphinx-quickstart', 'sphinx-quickstart', 'Sphinx documentation '
     'template generator', '', 1),

# We're not using intersphinx right now, but if we did, this would be part of
# the mapping:
intersphinx_mapping = {'python': ('', None)}

# -- Extension interface -------------------------------------------------------

from sphinx import addnodes

event_sig_re = re.compile(r'([a-zA-Z-]+)\s*\((.*)\)')

def parse_event(env, sig, signode):
    m = event_sig_re.match(sig)
    if not m:
        signode += addnodes.desc_name(sig, sig)
        return sig
    name, args = m.groups()
    signode += addnodes.desc_name(name, name)
    plist = addnodes.desc_parameterlist()
    for arg in args.split(','):
        arg = arg.strip()
        plist += addnodes.desc_parameter(arg, arg)
    signode += plist
    return name

def setup(app):
    from sphinx.ext.autodoc import cut_lines
    app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
    app.add_description_unit('confval', 'confval',
                             objname='configuration value',
                             indextemplate='pair: %s; configuration value')
    app.add_description_unit('event', 'event', 'pair: %s; event', parse_event)