source: trunk/docs/conf.py @ 674

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

Convert from Docutils to Sphinx for good

Make the switch to using Sphinx exclusively for generating the docs.
Rename all reST files to .rst so editors like PyCharm? automatically
will use syntax highlighting and linting for the reST format.

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