summaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorRoland Meister <Roland Meister@localhost>2011-02-28 23:15:35 +0100
committerRoland Meister <Roland Meister@localhost>2011-02-28 23:15:35 +0100
commit55c7fa44bb4d3646244a35fb595496afb933a46c (patch)
tree59d364f7b37c65c804350f8e88c3ce14c4182670 /doc/conf.py
parent9041a3396d46f4eaaf01355a3e83b10b0e01491e (diff)
parente46a8e9ded827c18ae6dd3f284250021f9ae95b1 (diff)
downloadsphinx-git-55c7fa44bb4d3646244a35fb595496afb933a46c.tar.gz
Merge with birkenfeld/sphinx.
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py26
1 files changed, 20 insertions, 6 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 8b76d23f1..19b952942 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -13,7 +13,7 @@ templates_path = ['_templates']
exclude_patterns = ['_build']
project = 'Sphinx'
-copyright = '2007-2010, Georg Brandl'
+copyright = '2007-2011, Georg Brandl'
version = sphinx.__released__
release = version
show_authors = True
@@ -21,7 +21,6 @@ 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 = 'http://sphinx.pocoo.org'
@@ -47,6 +46,7 @@ latex_logo = '_static/sphinx.png'
latex_elements = {
'fontpkg': '\\usepackage{palatino}',
}
+latex_show_urls = 'footnote'
autodoc_member_order = 'groupwise'
todo_include_todos = True
@@ -66,6 +66,16 @@ man_pages = [
'template generator', '', 1),
]
+texinfo_documents = [
+ ('contents', 'sphinx', 'Sphinx Documentation', 'Georg Brandl',
+ 'Sphinx', 'The Sphinx documentation builder.', 'Documentation tools',
+ 1),
+]
+
+# We're not using intersphinx right now, but if we did, this would be part of
+# the mapping:
+intersphinx_mapping = {'python': ('http://docs.python.org/dev', None)}
+
# -- Extension interface -------------------------------------------------------
@@ -91,8 +101,12 @@ def parse_event(env, sig, signode):
def setup(app):
from sphinx.ext.autodoc import cut_lines
+ from sphinx.util.docfields import GroupedField
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)
+ app.add_object_type('confval', 'confval',
+ objname='configuration value',
+ indextemplate='pair: %s; configuration value')
+ fdesc = GroupedField('parameter', label='Parameters',
+ names=['param'], can_collapse=True)
+ app.add_object_type('event', 'event', 'pair: %s; event', parse_event,
+ doc_field_types=[fdesc])