source: trunk/docs/conf.py @ 830

Last change on this file since 830 was 830, checked in by cito, 4 years ago

Avoid duplication in the title of the docs

The actual documentation comes only at the second level in the breadcrumb.

  • Property svn:keywords set to Author Date Id Revision
File size: 9.8 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# PyGreSQL documentation build configuration file.
4#
5# This file is execfile()d with the current directory set to its
6# containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
13
14import sys
15import os
16import shlex
17
18# Import Cloud theme (this will also automatically add the theme directory).
19# Note: We add a navigation bar to the cloud them using a custom layout.
20if os.environ.get('READTHEDOCS', None) == 'True':
21    # We cannot use our custom layout here, since RTD overrides layout.html.
22    use_cloud_theme = False
23else:
24    try:
25        import cloud_sptheme
26        use_cloud_theme = True
27    except ImportError:
28        use_cloud_theme = False
29
30# If extensions (or modules to document with autodoc) are in another directory,
31# add these directories to sys.path here. If the directory is relative to the
32# documentation root, use os.path.abspath to make it absolute, like shown here.
33#sys.path.insert(0, os.path.abspath('.'))
34
35# -- General configuration ------------------------------------------------
36
37# If your documentation needs a minimal Sphinx version, state it here.
38#needs_sphinx = '1.0'
39
40# Add any Sphinx extension module names here, as strings. They can be
41# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
42extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig']
43
44# Add any paths that contain templates here, relative to this directory.
45templates_path = ['_templates'] if use_cloud_theme else []
46
47# The suffix(es) of source filenames.
48# You can specify multiple suffix as a list of string:
49# source_suffix = ['.rst', '.md']
50source_suffix = '.rst'
51
52# The encoding of source files.
53#source_encoding = 'utf-8-sig'
54
55# The master toctree document.
56master_doc = 'index'
57
58# General information about the project.
59project = 'PyGreSQL'
60author = 'The PyGreSQL team'
61copyright = '2016, ' + author
62
63# The version info for the project you're documenting, acts as replacement for
64# |version| and |release|, also used in various other places throughout the
65# built documents.
66#
67# The short X.Y version.
68version = '5.0'
69# The full version, including alpha/beta/rc tags.
70release = '5.0'
71
72# The language for content autogenerated by Sphinx. Refer to documentation
73# for a list of supported languages.
74# This is also used if you do content translation via gettext catalogs.
75# Usually you set "language" from the command line for these cases.
76language = None
77
78# There are two options for replacing |today|: either, you set today to some
79# non-false value, then it is used:
80#today = ''
81# Else, today_fmt is used as the format for a strftime call.
82#today_fmt = '%B %d, %Y'
83
84# List of patterns, relative to source directory, that match files and
85# directories to ignore when looking for source files.
86exclude_patterns = ['_build']
87
88# List of pages which are included in other pages and therefore should
89# not appear in the toctree.
90exclude_patterns += [
91    'download/download.rst', 'download/files.rst',
92    'community/mailinglist.rst', 'community/source.rst',
93    'community/bugtracker.rst', 'community/support.rst',
94    'community/homes.rst']
95
96# The reST default role (used for this markup: `text`) for all documents.
97#default_role = None
98
99# If true, '()' will be appended to :func: etc. cross-reference text.
100#add_function_parentheses = True
101
102# If true, the current module name will be prepended to all description
103# unit titles (such as .. function::).
104#add_module_names = True
105
106# If true, sectionauthor and moduleauthor directives will be shown in the
107# output. They are ignored by default.
108#show_authors = False
109
110# The name of the Pygments (syntax highlighting) style to use.
111pygments_style = 'sphinx'
112
113# A list of ignored prefixes for module index sorting.
114#modindex_common_prefix = []
115
116
117# If true, keep warnings as "system message" paragraphs in the built documents.
118#keep_warnings = False
119
120# If true, `todo` and `todoList` produce output, else they produce nothing.
121todo_include_todos = False
122
123
124# -- Options for HTML output ----------------------------------------------
125
126# The theme to use for HTML and HTML Help pages.  See the documentation for
127# a list of builtin themes.
128html_theme = 'cloud' if use_cloud_theme else 'default'
129
130# Theme options are theme-specific and customize the look and feel of a theme
131# further.  For a list of options available for each theme, see the
132# documentation.
133html_theme_options = {'defaultcollapsed': True} if use_cloud_theme else {}
134
135# Add any paths that contain custom themes here, relative to this directory.
136html_theme_path = ['_themes']
137
138# The name for this set of Sphinx documents.  If None, it defaults to
139# "<project> v<release> documentation".
140html_title = None if use_cloud_theme else 'PyGreSQL %s' % version
141
142# A shorter title for the navigation bar.  Default is the same as html_title.
143#html_short_title = None
144
145# The name of an image file (relative to this directory) to place at the top
146# of the sidebar.
147html_logo = '_static/pygresql.png'
148
149# The name of an image file (within the static path) to use as favicon of the
150# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
151# pixels large.
152html_favicon = '_static/favicon.ico'
153
154# Add any paths that contain custom static files (such as style sheets) here,
155# relative to this directory. They are copied after the builtin static files,
156# so a file named "default.css" will overwrite the builtin "default.css".
157html_static_path = ['_static']
158
159# Add any extra paths that contain custom files (such as robots.txt or
160# .htaccess) here, relative to this directory. These files are copied
161# directly to the root of the documentation.
162#html_extra_path = []
163
164# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
165# using the given strftime format.
166#html_last_updated_fmt = '%b %d, %Y'
167
168# If true, SmartyPants will be used to convert quotes and dashes to
169# typographically correct entities.
170#html_use_smartypants = True
171
172# Custom sidebar templates, maps document names to template names.
173#html_sidebars = {}
174
175# Additional templates that should be rendered to pages, maps page names to
176# template names.
177#html_additional_pages = {}
178
179# If false, no module index is generated.
180#html_domain_indices = True
181
182# If false, no index is generated.
183#html_use_index = True
184
185# If true, the index is split into individual pages for each letter.
186#html_split_index = False
187
188# If true, links to the reST sources are added to the pages.
189#html_show_sourcelink = True
190
191# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
192#html_show_sphinx = True
193
194# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
195#html_show_copyright = True
196
197# If true, an OpenSearch description file will be output, and all pages will
198# contain a <link> tag referring to it.  The value of this option must be the
199# base URL from which the finished HTML is served.
200#html_use_opensearch = ''
201
202# This is the file name suffix for HTML files (e.g. ".xhtml").
203#html_file_suffix = None
204
205# Language to be used for generating the HTML full-text search index.
206# Sphinx supports the following languages:
207#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
208#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
209#html_search_language = 'en'
210
211# A dictionary with options for the search language support, empty by default.
212# Now only 'ja' uses this config value
213#html_search_options = {'type': 'default'}
214
215# The name of a javascript file (relative to the configuration directory) that
216# implements a search results scorer. If empty, the default will be used.
217#html_search_scorer = 'scorer.js'
218
219# Output file base name for HTML help builder.
220htmlhelp_basename = 'PyGreSQLdoc'
221
222
223# -- Options for LaTeX output ---------------------------------------------
224
225latex_elements = {
226# The paper size ('letterpaper' or 'a4paper').
227#'papersize': 'letterpaper',
228
229# The font size ('10pt', '11pt' or '12pt').
230#'pointsize': '10pt',
231
232# Additional stuff for the LaTeX preamble.
233#'preamble': '',
234
235# Latex figure (float) alignment
236#'figure_align': 'htbp',
237}
238
239# Grouping the document tree into LaTeX files. List of tuples
240# (source start file, target name, title,
241#  author, documentclass [howto, manual, or own class]).
242latex_documents = [
243    (master_doc, 'PyGreSQL.tex', 'PyGreSQL Documentation',
244     author, 'manual'),
245]
246
247# The name of an image file (relative to this directory) to place at the top of
248# the title page.
249#latex_logo = None
250
251# For "manual" documents, if this is true, then toplevel headings are parts,
252# not chapters.
253#latex_use_parts = False
254
255# If true, show page references after internal links.
256#latex_show_pagerefs = False
257
258# If true, show URL addresses after external links.
259#latex_show_urls = False
260
261# Documents to append as an appendix to all manuals.
262#latex_appendices = []
263
264# If false, no module index is generated.
265#latex_domain_indices = True
266
267
268# -- Options for manual page output ---------------------------------------
269
270# One entry per manual page. List of tuples
271# (source start file, name, description, authors, manual section).
272man_pages = [
273    (master_doc, 'pygresql', 'PyGreSQL Documentation', [author], 1)
274]
275
276# If true, show URL addresses after external links.
277#man_show_urls = False
278
279
280# -- Options for Texinfo output -------------------------------------------
281
282# Grouping the document tree into Texinfo files. List of tuples
283# (source start file, target name, title, author,
284#  dir menu entry, description, category)
285texinfo_documents = [
286    (master_doc, 'PyGreSQL', u'PyGreSQL Documentation',
287     author, 'PyGreSQL', 'One line description of project.',
288     'Miscellaneous'),
289]
290
291# Documents to append as an appendix to all manuals.
292#texinfo_appendices = []
293
294# If false, no module index is generated.
295#texinfo_domain_indices = True
296
297# How to display URL addresses: 'footnote', 'no', or 'inline'.
298#texinfo_show_urls = 'footnote'
299
300# If true, do not generate a @detailmenu in the "Top" node's menu.
301#texinfo_no_detailmenu = False
Note: See TracBrowser for help on using the repository browser.