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

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

Update Sphinx conf and make files

Update the conf and make files for creating the documentation
so that newer Sphinx features are supported.

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