summaryrefslogtreecommitdiffstats
path: root/Doc/conf.py
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-10-29 07:04:27 (GMT)
committerGeorg Brandl <georg@python.org>2014-10-29 07:04:27 (GMT)
commit9a333a6f65b7b2eb3fbed0d918186737adc6ae69 (patch)
treeebe88f50ed3a54bf2a55599280ca203df290e565 /Doc/conf.py
parent3fdea95307966b5b1e5e6b6bbc453e8fb6bac4b6 (diff)
downloadcpython-9a333a6f65b7b2eb3fbed0d918186737adc6ae69.zip
cpython-9a333a6f65b7b2eb3fbed0d918186737adc6ae69.tar.gz
cpython-9a333a6f65b7b2eb3fbed0d918186737adc6ae69.tar.bz2
Remove a few config values that keep the default values, move values to the correct section
Diffstat (limited to 'Doc/conf.py')
-rw-r--r--Doc/conf.py25
1 files changed, 11 insertions, 14 deletions
diff --git a/Doc/conf.py b/Doc/conf.py
index 59d9cfa..0c7b601 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -14,7 +14,6 @@ sys.path.append(os.path.abspath('tools'))
extensions = ['sphinx.ext.coverage', 'sphinx.ext.doctest',
'pyspecific', 'c_annotations']
-templates_path = ['tools']
# General substitutions.
project = 'Python'
@@ -31,16 +30,6 @@ today = ''
# Else, today_fmt is used as the format for a strftime call.
today_fmt = '%B %d, %Y'
-# Relative filename of the reference count data file.
-refcount_file = 'data/refcounts.dat'
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-add_module_names = True
-
# By default, highlight as Python 3.
highlight_language = 'python3'
@@ -51,19 +40,20 @@ needs_sphinx = '1.2'
# Options for HTML output
# -----------------------
+# Use our custom theme.
html_theme = 'pydoctheme'
html_theme_path = ['tools']
html_theme_options = {'collapsiblesidebar': True}
+# Short title used e.g. for <title> HTML tags.
html_short_title = '%s Documentation' % release
# 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'
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-html_use_smartypants = True
+# Path to find HTML templates.
+templates_path = ['tools']
# Custom sidebar templates, filenames relative to this file.
html_sidebars = {
@@ -145,6 +135,7 @@ latex_appendices = ['glossary', 'about', 'license', 'copyright']
# Get LaTeX to handle Unicode correctly
latex_elements = {'inputenc': r'\usepackage[utf8x]{inputenc}', 'utf8extra': ''}
+
# Options for the coverage checker
# --------------------------------
@@ -180,3 +171,9 @@ coverage_c_regexes = {
coverage_ignore_c_items = {
# 'cfunction': [...]
}
+
+# Options for extensions
+# ----------------------
+
+# Relative filename of the reference count data file.
+refcount_file = 'data/refcounts.dat'