From 31c5290fb8ffa8ff66ec30f5c8ac32c0fd31fbdb Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 17 Jan 2010 18:16:14 +0100 Subject: [PATCH] Clean up conf.py file for the docs. --- doc/conf.py | 50 +++----------------------------------------------- 1 file changed, 3 insertions(+), 47 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 836ad52eb..cff9af6e7 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -2,69 +2,33 @@ # # Sphinx documentation build configuration file -import sys, os, re +import re +import sphinx -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.addons.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.autosummary'] -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. master_doc = 'contents' - +templates_path = ['_templates'] exclude_patterns = ['_build'] -# General substitutions. project = 'Sphinx' copyright = '2007-2010, Georg Brandl' - -# The default replacements for |version| and |release|, also used in various -# other places throughout the built documents. -import sphinx version = sphinx.__released__ release = version -# Show author directives in the output. show_authors = True -# The HTML template theme. html_theme = 'sphinxdoc' - -# A list of ignored prefixes names for module index sorting. modindex_common_prefix = ['sphinx.'] - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%b %d, %Y' - -# Content template for the index page. html_index = 'index.html' - -# Custom sidebar templates, maps page names to templates. html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']} - -# Additional templates that should be rendered to pages, maps page names to -# templates. html_additional_pages = {'index': 'index.html'} - -# Generate an OpenSearch description with that URL as the base. html_use_opensearch = 'http://sphinx.pocoo.org' -# Output file base name for HTML help builder. htmlhelp_basename = 'Sphinxdoc' -# Epub fields epub_theme = 'epub' epub_basename = 'sphinx' epub_author = 'Georg Brandl' @@ -76,21 +40,13 @@ epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js', '_static/jquery.js', '_static/searchtools.js', '_static/basic.css', 'search.html'] - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [('contents', 'sphinx.tex', 'Sphinx Documentation', 'Georg Brandl', 'manual', 1)] - -# Add our logo to the LaTeX file. latex_logo = '_static/sphinx.png' - -# Additional stuff for the LaTeX preamble. latex_elements = { 'fontpkg': '\\usepackage{palatino}', } -# Put TODOs into the output. todo_include_todos = True