source: trunk/docs/conf.py @ 752

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

Add new logo to the sidebar of the documentation

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