source: trunk/docs/conf.py @ 828

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

Fix silly typo.

  • Property svn:keywords set to Author Date Id Revision
File size: 10.0 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']
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' if use_cloud_theme else 'toc'
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']
95if use_cloud_theme:
96    # We use a naviagtion bar instead of the table of contents
97    # and we include the about page on the index page.
98    exclude_patterns += ['toc.rst', 'about.rst']
99else:
100    exclude_patterns += ['index.rst']
101
102# The reST default role (used for this markup: `text`) for all documents.
103#default_role = None
104
105# If true, '()' will be appended to :func: etc. cross-reference text.
106#add_function_parentheses = True
107
108# If true, the current module name will be prepended to all description
109# unit titles (such as .. function::).
110#add_module_names = True
111
112# If true, sectionauthor and moduleauthor directives will be shown in the
113# output. They are ignored by default.
114#show_authors = False
115
116# The name of the Pygments (syntax highlighting) style to use.
117pygments_style = 'sphinx'
118
119# A list of ignored prefixes for module index sorting.
120#modindex_common_prefix = []
121
122
123# If true, keep warnings as "system message" paragraphs in the built documents.
124#keep_warnings = False
125
126# If true, `todo` and `todoList` produce output, else they produce nothing.
127todo_include_todos = False
128
129
130# -- Options for HTML output ----------------------------------------------
131
132# The theme to use for HTML and HTML Help pages.  See the documentation for
133# a list of builtin themes.
134html_theme = 'cloud' if use_cloud_theme else 'default'
135
136# Theme options are theme-specific and customize the look and feel of a theme
137# further.  For a list of options available for each theme, see the
138# documentation.
139html_theme_options = {'defaultcollapsed': True} if use_cloud_theme else {}
140
141# Add any paths that contain custom themes here, relative to this directory.
142html_theme_path = ['_themes']
143
144# The name for this set of Sphinx documents.  If None, it defaults to
145# "<project> v<release> documentation".
146#html_title = None
147
148# A shorter title for the navigation bar.  Default is the same as html_title.
149#html_short_title = None
150
151# The name of an image file (relative to this directory) to place at the top
152# of the sidebar.
153html_logo = '_static/pygresql.png'
154
155# The name of an image file (within the static path) to use as favicon of the
156# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
157# pixels large.
158html_favicon = '_static/favicon.ico'
159
160# Add any paths that contain custom static files (such as style sheets) here,
161# relative to this directory. They are copied after the builtin static files,
162# so a file named "default.css" will overwrite the builtin "default.css".
163html_static_path = ['_static']
164
165# Add any extra paths that contain custom files (such as robots.txt or
166# .htaccess) here, relative to this directory. These files are copied
167# directly to the root of the documentation.
168#html_extra_path = []
169
170# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
171# using the given strftime format.
172#html_last_updated_fmt = '%b %d, %Y'
173
174# If true, SmartyPants will be used to convert quotes and dashes to
175# typographically correct entities.
176#html_use_smartypants = True
177
178# Custom sidebar templates, maps document names to template names.
179#html_sidebars = {}
180
181# Additional templates that should be rendered to pages, maps page names to
182# template names.
183#html_additional_pages = {}
184
185# If false, no module index is generated.
186#html_domain_indices = True
187
188# If false, no index is generated.
189#html_use_index = True
190
191# If true, the index is split into individual pages for each letter.
192#html_split_index = False
193
194# If true, links to the reST sources are added to the pages.
195#html_show_sourcelink = True
196
197# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
198#html_show_sphinx = True
199
200# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
201#html_show_copyright = True
202
203# If true, an OpenSearch description file will be output, and all pages will
204# contain a <link> tag referring to it.  The value of this option must be the
205# base URL from which the finished HTML is served.
206#html_use_opensearch = ''
207
208# This is the file name suffix for HTML files (e.g. ".xhtml").
209#html_file_suffix = None
210
211# Language to be used for generating the HTML full-text search index.
212# Sphinx supports the following languages:
213#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
214#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
215#html_search_language = 'en'
216
217# A dictionary with options for the search language support, empty by default.
218# Now only 'ja' uses this config value
219#html_search_options = {'type': 'default'}
220
221# The name of a javascript file (relative to the configuration directory) that
222# implements a search results scorer. If empty, the default will be used.
223#html_search_scorer = 'scorer.js'
224
225# Output file base name for HTML help builder.
226htmlhelp_basename = 'PyGreSQLdoc'
227
228
229# -- Options for LaTeX output ---------------------------------------------
230
231latex_elements = {
232# The paper size ('letterpaper' or 'a4paper').
233#'papersize': 'letterpaper',
234
235# The font size ('10pt', '11pt' or '12pt').
236#'pointsize': '10pt',
237
238# Additional stuff for the LaTeX preamble.
239#'preamble': '',
240
241# Latex figure (float) alignment
242#'figure_align': 'htbp',
243}
244
245# Grouping the document tree into LaTeX files. List of tuples
246# (source start file, target name, title,
247#  author, documentclass [howto, manual, or own class]).
248latex_documents = [
249    (master_doc, 'PyGreSQL.tex', 'PyGreSQL Documentation',
250     author, 'manual'),
251]
252
253# The name of an image file (relative to this directory) to place at the top of
254# the title page.
255#latex_logo = None
256
257# For "manual" documents, if this is true, then toplevel headings are parts,
258# not chapters.
259#latex_use_parts = False
260
261# If true, show page references after internal links.
262#latex_show_pagerefs = False
263
264# If true, show URL addresses after external links.
265#latex_show_urls = False
266
267# Documents to append as an appendix to all manuals.
268#latex_appendices = []
269
270# If false, no module index is generated.
271#latex_domain_indices = True
272
273
274# -- Options for manual page output ---------------------------------------
275
276# One entry per manual page. List of tuples
277# (source start file, name, description, authors, manual section).
278man_pages = [
279    (master_doc, 'pygresql', 'PyGreSQL Documentation', [author], 1)
280]
281
282# If true, show URL addresses after external links.
283#man_show_urls = False
284
285
286# -- Options for Texinfo output -------------------------------------------
287
288# Grouping the document tree into Texinfo files. List of tuples
289# (source start file, target name, title, author,
290#  dir menu entry, description, category)
291texinfo_documents = [
292    (master_doc, 'PyGreSQL', u'PyGreSQL Documentation',
293     author, 'PyGreSQL', 'One line description of project.',
294     'Miscellaneous'),
295]
296
297# Documents to append as an appendix to all manuals.
298#texinfo_appendices = []
299
300# If false, no module index is generated.
301#texinfo_domain_indices = True
302
303# How to display URL addresses: 'footnote', 'no', or 'inline'.
304#texinfo_show_urls = 'footnote'
305
306# If true, do not generate a @detailmenu in the "Top" node's menu.
307#texinfo_no_detailmenu = False
Note: See TracBrowser for help on using the repository browser.