summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorTshepang Lekhonkhobe <tshepang@gmail.com>2013-04-06 08:11:45 +0200
committerTshepang Lekhonkhobe <tshepang@gmail.com>2013-04-06 08:16:32 +0200
commit0435ccd15f7c7c3960208d0bac413cd8eb42cd56 (patch)
tree3ab7fdef9a49e01e2c809886b8360ddfc7d6be90 /docs/conf.py
parenta62ebd5725338d753d49ff1b6b8bf0fe95b19c92 (diff)
downloadpyramid-0435ccd15f7c7c3960208d0bac413cd8eb42cd56.tar.gz
pyramid-0435ccd15f7c7c3960208d0bac413cd8eb42cd56.tar.bz2
pyramid-0435ccd15f7c7c3960208d0bac413cd8eb42cd56.zip
trim commented-out parts of docs/conf.py
proposed here: https://groups.google.com/forum/?fromgroups=#!topic/pylons-devel/n2-7zvLWK3E
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py91
1 files changed, 2 insertions, 89 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 1ddcae08e..33bedc9dd 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -101,39 +101,19 @@ release = version
# Else, today_fmt is used as the format for a strftime call.
today_fmt = '%B %d, %Y'
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_themes/README.rst', ]
-# List of directories, relative to source directories, that shouldn't be searched
-# for source files.
-#exclude_dirs = []
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# 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 = False
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
# The name of the Pygments (syntax highlighting) style to use.
#pygments_style = book and 'bw' or 'tango'
if book:
pygments_style = 'bw'
-# The default language to highlight source code in.
-#highlight_language = 'guess'
-
# Options for HTML output
# -----------------------
@@ -169,67 +149,15 @@ html_theme_options = dict(
github_url='https://github.com/Pylons/pyramid',
# in_progress='true',
)
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-#html_style = 'pyramid.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'The Pyramid Web Application Development Framework v%s' % release
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = 'Home'
-
-# The name of an image file (within the static path) to place at the top of
-# the sidebar.
-#html_logo = '_static/pyramid.png'
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = '_static/pyramid.ico'
-
-# 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'
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_use_modindex = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
# Output file base name for HTML help builder.
htmlhelp_basename = 'pyramid'
@@ -252,20 +180,10 @@ latex_documents = [
'Chris McDonough', 'manual'),
]
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = '_static/pylons_small.png'
-
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
latex_use_parts = True
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
# If false, no module index is generated.
latex_use_modindex = False
@@ -508,13 +426,6 @@ epub_identifier = '0615445675'
# A unique identification for the text.
epub_uid = 'The Pyramid Web Application Development Framework, Version %s' \
% release
-# HTML files that should be inserted before the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_pre_files = []
-
-# HTML files shat should be inserted after the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js',
@@ -524,3 +435,5 @@ epub_exclude_files = ['_static/opensearch.xml', '_static/doctools.js',
# The depth of the table of contents in toc.ncx.
epub_tocdepth = 3
+
+# For a list of all settings, visit http://sphinx-doc.org/config.html.