docs/conf.py
author Radek Brich <radek.brich@devl.cz>
Sat, 05 Jan 2013 18:44:56 +0100
changeset 50 c5b8b9d2da95
parent 38 c6e170452c7f
permissions -rw-r--r--
DriverSDL: Implement colors.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     2
#
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     3
# Tuikit documentation build configuration file, created by
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     4
# sphinx-quickstart on Wed Feb  2 23:35:28 2011.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     5
#
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     6
# This file is execfile()d with the current directory set to its containing dir.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     7
#
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     8
# Note that not all possible configuration values are present in this
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     9
# autogenerated file.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    10
#
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    11
# All configuration values have a default; values that are commented out
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    12
# serve to show the default.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    13
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    14
import sys, os
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    15
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    16
# If extensions (or modules to document with autodoc) are in another directory,
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    17
# add these directories to sys.path here. If the directory is relative to the
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    18
# documentation root, use os.path.abspath to make it absolute, like shown here.
12
bb7d41be0c44 Update EventSource documentation.
Radek Brich <radek.brich@devl.cz>
parents: 0
diff changeset
    19
sys.path.append(os.path.abspath('..'))
0
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    20
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    21
# -- General configuration -----------------------------------------------------
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    22
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    23
# Add any Sphinx extension module names here, as strings. They can be extensions
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    24
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
14
1f2ff9d3c7f9 Add inheritance diagram to documentation.
Radek Brich <radek.brich@devl.cz>
parents: 13
diff changeset
    25
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.inheritance_diagram', 'sphinx.ext.viewcode']
0
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    26
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    27
# Add any paths that contain templates here, relative to this directory.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    28
templates_path = ['_templates']
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    29
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    30
# The suffix of source filenames.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    31
source_suffix = '.rst'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    32
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    33
# The encoding of source files.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    34
#source_encoding = 'utf-8'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    35
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    36
# The master toctree document.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    37
master_doc = 'index'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    38
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    39
# General information about the project.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    40
project = u'Tuikit'
38
c6e170452c7f Documentation, fix names of focus methods.
Radek Brich <radek.brich@devl.cz>
parents: 14
diff changeset
    41
copyright = u'2011-2012, Radek Brich'
0
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    42
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    43
# The version info for the project you're documenting, acts as replacement for
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    44
# |version| and |release|, also used in various other places throughout the
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    45
# built documents.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    46
#
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    47
# The short X.Y version.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    48
version = '0.5'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    49
# The full version, including alpha/beta/rc tags.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    50
release = '0.5a'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    51
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    52
# The language for content autogenerated by Sphinx. Refer to documentation
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    53
# for a list of supported languages.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    54
#language = None
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    55
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    56
# There are two options for replacing |today|: either, you set today to some
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    57
# non-false value, then it is used:
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    58
#today = ''
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    59
# Else, today_fmt is used as the format for a strftime call.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    60
#today_fmt = '%B %d, %Y'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    61
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    62
# List of documents that shouldn't be included in the build.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    63
#unused_docs = []
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    64
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    65
# List of directories, relative to source directory, that shouldn't be searched
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    66
# for source files.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    67
exclude_trees = ['_build']
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    68
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    69
# The reST default role (used for this markup: `text`) to use for all documents.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    70
#default_role = None
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    71
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    72
# If true, '()' will be appended to :func: etc. cross-reference text.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    73
#add_function_parentheses = True
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    74
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    75
# If true, the current module name will be prepended to all description
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    76
# unit titles (such as .. function::).
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    77
#add_module_names = True
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    78
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    79
# If true, sectionauthor and moduleauthor directives will be shown in the
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    80
# output. They are ignored by default.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    81
#show_authors = False
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    82
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    83
# The name of the Pygments (syntax highlighting) style to use.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    84
pygments_style = 'sphinx'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    85
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    86
# A list of ignored prefixes for module index sorting.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    87
#modindex_common_prefix = []
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    88
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    89
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    90
# -- Options for HTML output ---------------------------------------------------
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    91
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    92
# The theme to use for HTML and HTML Help pages.  Major themes that come with
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    93
# Sphinx are currently 'default' and 'sphinxdoc'.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    94
html_theme = 'default'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    95
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    96
# Theme options are theme-specific and customize the look and feel of a theme
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    97
# further.  For a list of options available for each theme, see the
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    98
# documentation.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    99
#html_theme_options = {}
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   100
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   101
# Add any paths that contain custom themes here, relative to this directory.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   102
#html_theme_path = []
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   103
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   104
# The name for this set of Sphinx documents.  If None, it defaults to
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   105
# "<project> v<release> documentation".
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   106
#html_title = None
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   107
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   108
# A shorter title for the navigation bar.  Default is the same as html_title.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   109
#html_short_title = None
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   110
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   111
# The name of an image file (relative to this directory) to place at the top
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   112
# of the sidebar.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   113
#html_logo = None
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   114
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   115
# The name of an image file (within the static path) to use as favicon of the
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   116
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   117
# pixels large.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   118
#html_favicon = None
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   119
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   120
# Add any paths that contain custom static files (such as style sheets) here,
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   121
# relative to this directory. They are copied after the builtin static files,
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   122
# so a file named "default.css" will overwrite the builtin "default.css".
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   123
html_static_path = ['_static']
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   124
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   125
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   126
# using the given strftime format.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   127
#html_last_updated_fmt = '%b %d, %Y'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   128
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   129
# If true, SmartyPants will be used to convert quotes and dashes to
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   130
# typographically correct entities.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   131
#html_use_smartypants = True
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   132
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   133
# Custom sidebar templates, maps document names to template names.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   134
#html_sidebars = {}
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   135
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   136
# Additional templates that should be rendered to pages, maps page names to
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   137
# template names.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   138
#html_additional_pages = {}
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   139
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   140
# If false, no module index is generated.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   141
#html_use_modindex = True
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   142
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   143
# If false, no index is generated.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   144
#html_use_index = True
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   145
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   146
# If true, the index is split into individual pages for each letter.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   147
#html_split_index = False
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   148
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   149
# If true, links to the reST sources are added to the pages.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   150
#html_show_sourcelink = True
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   151
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   152
# If true, an OpenSearch description file will be output, and all pages will
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   153
# contain a <link> tag referring to it.  The value of this option must be the
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   154
# base URL from which the finished HTML is served.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   155
#html_use_opensearch = ''
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   156
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   157
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   158
#html_file_suffix = ''
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   159
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   160
# Output file base name for HTML help builder.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   161
htmlhelp_basename = 'Tuikitdoc'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   162
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   163
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   164
# -- Options for LaTeX output --------------------------------------------------
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   165
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   166
# The paper size ('letter' or 'a4').
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   167
#latex_paper_size = 'letter'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   168
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   169
# The font size ('10pt', '11pt' or '12pt').
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   170
#latex_font_size = '10pt'
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   171
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   172
# Grouping the document tree into LaTeX files. List of tuples
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   173
# (source start file, target name, title, author, documentclass [howto/manual]).
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   174
latex_documents = [
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   175
  ('index', 'Tuikit.tex', u'Tuikit Documentation',
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   176
   u'Radek Brich', 'manual'),
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   177
]
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   178
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   179
# The name of an image file (relative to this directory) to place at the top of
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   180
# the title page.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   181
#latex_logo = None
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   182
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   183
# For "manual" documents, if this is true, then toplevel headings are parts,
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   184
# not chapters.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   185
#latex_use_parts = False
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   186
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   187
# Additional stuff for the LaTeX preamble.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   188
#latex_preamble = ''
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   189
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   190
# Documents to append as an appendix to all manuals.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   191
#latex_appendices = []
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   192
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   193
# If false, no module index is generated.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
   194
#latex_use_modindex = True
13
19ebde2fd594 Add more generated documentation.
Radek Brich <radek.brich@devl.cz>
parents: 12
diff changeset
   195
19ebde2fd594 Add more generated documentation.
Radek Brich <radek.brich@devl.cz>
parents: 12
diff changeset
   196
19ebde2fd594 Add more generated documentation.
Radek Brich <radek.brich@devl.cz>
parents: 12
diff changeset
   197
autodoc_member_order = 'bysource'