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