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

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

Reorganize and improve the Sphinx docs

The Sphinx HTML docs can now also serve as home page for the project.
They can be built with the mkdocs script and can then be found in the
docs/_build/html directory (this needs sphinx and the cloud_sptheme).

The "actual" core docs can be found in docs/contents. The layout has
been modified to only show these pages with the typical documentation
relbars; the other pages of the homepage use a simpler layout. The
pg and pgdb documentation has been cut in chunks and can now be found
in docs/contents/pg and docs/contents/pgdb.

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