source: branches/4.x/docs/conf.py @ 661

Last change on this file since 661 was 661, checked in by darcy, 4 years ago

Update copyright.

  • Property svn:keywords set to Author Date Id Revision
File size: 7.7 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# PyGreSQL documentation build configuration file, created by
4# sphinx-quickstart on Thu Nov  1 07:47:06 2012.
5#
6# This file is execfile()d with the current directory set to its 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, os
15
16# import Cloud
17import cloud_sptheme as csp
18
19# If extensions (or modules to document with autodoc) are in another directory,
20# add these directories to sys.path here. If the directory is relative to the
21# documentation root, use os.path.abspath to make it absolute, like shown here.
22#sys.path.insert(0, os.path.abspath('.'))
23
24# -- General configuration -----------------------------------------------------
25
26# If your documentation needs a minimal Sphinx version, state it here.
27#needs_sphinx = '1.0'
28
29# Add any Sphinx extension module names here, as strings. They can be extensions
30# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31extensions = ['sphinx.ext.autodoc']
32
33# Add any paths that contain templates here, relative to this directory.
34templates_path = ['_templates']
35
36# The suffix of source filenames.
37source_suffix = '.rst'
38
39# The encoding of source files.
40#source_encoding = 'utf-8-sig'
41
42# The master toctree document.
43master_doc = 'index'
44
45# General information about the project.
46project = u'PyGreSQL'
47copyright = u'2015, The PyGreSQL team'
48
49# The version info for the project you're documenting, acts as replacement for
50# |version| and |release|, also used in various other places throughout the
51# built documents.
52#
53# The short X.Y version.
54version = '4.2'
55# The full version, including alpha/beta/rc tags.
56release = '4.2'
57
58# The language for content autogenerated by Sphinx. Refer to documentation
59# for a list of supported languages.
60#language = None
61
62# There are two options for replacing |today|: either, you set today to some
63# non-false value, then it is used:
64#today = ''
65# Else, today_fmt is used as the format for a strftime call.
66#today_fmt = '%B %d, %Y'
67
68# List of patterns, relative to source directory, that match files and
69# directories to ignore when looking for source files.
70exclude_patterns = ['_build']
71
72# The reST default role (used for this markup: `text`) to use for all documents.
73#default_role = None
74
75# If true, '()' will be appended to :func: etc. cross-reference text.
76#add_function_parentheses = True
77
78# If true, the current module name will be prepended to all description
79# unit titles (such as .. function::).
80#add_module_names = True
81
82# If true, sectionauthor and moduleauthor directives will be shown in the
83# output. They are ignored by default.
84#show_authors = False
85
86# The name of the Pygments (syntax highlighting) style to use.
87pygments_style = 'sphinx'
88
89# A list of ignored prefixes for module index sorting.
90#modindex_common_prefix = []
91
92
93# -- Options for HTML output ---------------------------------------------------
94
95# The theme to use for HTML and HTML Help pages.  See the documentation for
96# a list of builtin themes.
97html_theme = 'cloud'
98
99# Theme options are theme-specific and customize the look and feel of a theme
100# further.  For a list of options available for each theme, see the
101# documentation.
102html_theme_options = { "defaultcollapsed": True, }
103
104# Add any paths that contain custom themes here, relative to this directory.
105html_theme_path = [csp.get_theme_dir()]
106
107# The name for this set of Sphinx documents.  If None, it defaults to
108# "<project> v<release> documentation".
109#html_title = None
110
111# A shorter title for the navigation bar.  Default is the same as html_title.
112#html_short_title = None
113
114# The name of an image file (relative to this directory) to place at the top
115# of the sidebar.
116#html_logo = None
117
118# The name of an image file (within the static path) to use as favicon of the
119# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
120# pixels large.
121#html_favicon = None
122
123# Add any paths that contain custom static files (such as style sheets) here,
124# relative to this directory. They are copied after the builtin static files,
125# so a file named "default.css" will overwrite the builtin "default.css".
126html_static_path = ['_static']
127
128# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129# using the given strftime format.
130#html_last_updated_fmt = '%b %d, %Y'
131
132# If true, SmartyPants will be used to convert quotes and dashes to
133# typographically correct entities.
134#html_use_smartypants = True
135
136# Custom sidebar templates, maps document names to template names.
137#html_sidebars = {}
138
139# Additional templates that should be rendered to pages, maps page names to
140# template names.
141#html_additional_pages = {}
142
143# If false, no module index is generated.
144#html_domain_indices = True
145
146# If false, no index is generated.
147#html_use_index = True
148
149# If true, the index is split into individual pages for each letter.
150#html_split_index = False
151
152# If true, links to the reST sources are added to the pages.
153#html_show_sourcelink = True
154
155# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
156#html_show_sphinx = True
157
158# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
159#html_show_copyright = True
160
161# If true, an OpenSearch description file will be output, and all pages will
162# contain a <link> tag referring to it.  The value of this option must be the
163# base URL from which the finished HTML is served.
164#html_use_opensearch = ''
165
166# This is the file name suffix for HTML files (e.g. ".xhtml").
167#html_file_suffix = None
168
169# Output file base name for HTML help builder.
170htmlhelp_basename = 'PyGreSQLdoc'
171
172
173# -- Options for LaTeX output --------------------------------------------------
174
175latex_elements = {
176# The paper size ('letterpaper' or 'a4paper').
177#'papersize': 'letterpaper',
178
179# The font size ('10pt', '11pt' or '12pt').
180#'pointsize': '10pt',
181
182# Additional stuff for the LaTeX preamble.
183#'preamble': '',
184}
185
186# Grouping the document tree into LaTeX files. List of tuples
187# (source start file, target name, title, author, documentclass [howto/manual]).
188latex_documents = [
189  ('index', 'PyGreSQL.tex', u'PyGreSQL Documentation',
190   u'The PyGreSQL team', 'manual'),
191]
192
193# The name of an image file (relative to this directory) to place at the top of
194# the title page.
195#latex_logo = None
196
197# For "manual" documents, if this is true, then toplevel headings are parts,
198# not chapters.
199#latex_use_parts = False
200
201# If true, show page references after internal links.
202#latex_show_pagerefs = False
203
204# If true, show URL addresses after external links.
205#latex_show_urls = False
206
207# Documents to append as an appendix to all manuals.
208#latex_appendices = []
209
210# If false, no module index is generated.
211#latex_domain_indices = True
212
213
214# -- Options for manual page output --------------------------------------------
215
216# One entry per manual page. List of tuples
217# (source start file, name, description, authors, manual section).
218man_pages = [
219    ('index', 'pygresql', u'PyGreSQL Documentation',
220     [u'The PyGreSQL team'], 1)
221]
222
223# If true, show URL addresses after external links.
224#man_show_urls = False
225
226
227# -- Options for Texinfo output ------------------------------------------------
228
229# Grouping the document tree into Texinfo files. List of tuples
230# (source start file, target name, title, author,
231#  dir menu entry, description, category)
232texinfo_documents = [
233  ('index', 'PyGreSQL', u'PyGreSQL Documentation',
234   u'The PyGreSQL team', 'PyGreSQL', 'One line description of project.',
235   'Miscellaneous'),
236]
237
238# Documents to append as an appendix to all manuals.
239#texinfo_appendices = []
240
241# If false, no module index is generated.
242#texinfo_domain_indices = True
243
244# How to display URL addresses: 'footnote', 'no', or 'inline'.
245#texinfo_show_urls = 'footnote'
Note: See TracBrowser for help on using the repository browser.