1
# -*- coding: utf-8 -*-
3
# Chaco documentation build configuration file, created by
4
# sphinx-quickstart on Mon Jul 21 21:01:40 2008.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# The contents of this file are pickled, so don't put values in the namespace
9
# that aren't pickleable (module imports are okay, they're removed automatically).
11
# All configuration values have a default value; values that are commented out
12
# serve to show the default value.
16
# If your extensions are in another directory, add it here. If the directory
17
# is relative to the documentation root, use os.path.abspath to make it
18
# absolute, like shown here.
19
sys.path.append(os.path.abspath('sphinxext'))
21
# General configuration
22
# ---------------------
24
# Add any Sphinx extension module names here, as strings. They can be extensions
25
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26
extensions = ['sphinx.ext.autodoc', 'traitsdoc']
28
# Add any paths that contain templates here, relative to this directory.
29
templates_path = ['_templates']
31
# The suffix of source filenames.
32
source_suffix = '.rst'
34
# The master toctree document.
37
# General substitutions.
39
copyright = '2008-2011, Enthought, Inc.'
41
# The default replacements for |version| and |release|, also used in various
42
# other places throughout the built documents.
44
execfile(os.path.join('..', '..', 'chaco', '__init__.py'), d)
45
version = release = d['__version__']
47
# There are two options for replacing |today|: either, you set today to some
48
# non-false value, then it is used:
50
# Else, today_fmt is used as the format for a strftime call.
51
today_fmt = '%B %d, %Y'
53
# List of documents that shouldn't be included in the build.
56
# List of directories, relative to source directories, that shouldn't be searched
60
# The reST default role (used for this markup: `text`) to use for all documents.
63
# If true, '()' will be appended to :func: etc. cross-reference text.
64
#add_function_parentheses = True
66
# If true, the current module name will be prepended to all description
67
# unit titles (such as .. function::).
68
#add_module_names = True
70
# If true, sectionauthor and moduleauthor directives will be shown in the
71
# output. They are ignored by default.
74
# The name of the Pygments (syntax highlighting) style to use.
75
pygments_style = 'sphinx'
78
# Options for HTML output
79
# -----------------------
81
# The style sheet to use for HTML and HTML Help pages. A file of that name
82
# must exist either in Sphinx' static/ path, or in one of the custom paths
83
# given in html_static_path.
84
html_style = 'default.css'
86
# The name for this set of Sphinx documents. If None, it defaults to
87
# "<project> v<release> documentation".
90
# A shorter title for the navigation bar. Default is the same as html_title.
91
#html_short_title = None
93
# The name of an image file (within the static path) to place at the top of
95
html_logo = '_static/e-logo-rev.png'
97
# The name of an image file (within the static path) to use as favicon of the
98
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
100
html_favicon = 'et.ico'
102
# Add any paths that contain custom static files (such as style sheets) here,
103
# relative to this directory. They are copied after the builtin static files,
104
# so a file named "default.css" will overwrite the builtin "default.css".
105
html_static_path = ['_static']
107
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
108
# using the given strftime format.
109
html_last_updated_fmt = '%b %d, %Y'
111
# If true, SmartyPants will be used to convert quotes and dashes to
112
# typographically correct entities.
113
html_use_smartypants = True
115
# Custom sidebar templates, maps document names to template names.
118
# Additional templates that should be rendered to pages, maps page names to
120
#html_additional_pages = {}
122
# If false, no module index is generated.
123
html_use_modindex = False
125
# If false, no index is generated.
126
html_use_index = False
128
# If true, the index is split into individual pages for each letter.
129
#html_split_index = False
131
# If true, the reST sources are included in the HTML build as _sources/<name>.
132
#html_copy_source = False
134
# If true, an OpenSearch description file will be output, and all pages will
135
# contain a <link> tag referring to it. The value of this option must be the
136
# base URL from which the finished HTML is served.
137
#html_use_opensearch = ''
139
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
140
#html_file_suffix = ''
142
# Output file base name for HTML help builder.
143
htmlhelp_basename = 'Chacodoc'
146
# Options for LaTeX output
147
# ------------------------
149
# The paper size ('letter' or 'a4').
150
#latex_paper_size = 'letter'
152
# The font size ('10pt', '11pt' or '12pt').
153
#latex_font_size = '10pt'
155
# Grouping the document tree into LaTeX files. List of tuples
156
# (source start file, target name, title, author, document class [howto/manual]).
158
('index', 'Chaco.tex', 'Chaco Documentation', 'Enthought', 'manual'),
161
# The name of an image file (relative to this directory) to place at the top of
165
# For "manual" documents, if this is true, then toplevel headings are parts,
167
#latex_use_parts = False
169
# Additional stuff for the LaTeX preamble.
172
# Documents to append as an appendix to all manuals.
173
#latex_appendices = []
175
# If false, no module index is generated.
176
#latex_use_modindex = True
added
removed
docs/source/conf.py
