1
# -*- coding: utf-8 -*-
3
# Mayavi2 documentation build configuration file, created by
4
# sphinx-quickstart on Sat Apr 12 23:25:24 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.
17
#sys.path.append('some/directory')
19
# General configuration
20
# ---------------------
22
# Add any Sphinx extension module names here, as strings. They can be extensions
23
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26
# Add any paths that contain templates here, relative to this directory.
27
templates_path = ['.templates']
29
# The suffix of source filenames.
30
source_suffix = '.rst'
32
# The master toctree document.
35
# General substitutions.
37
copyright = '2008, Prabhu Ramachandran, Gaël Varoquaux'
39
# The default replacements for |version| and |release|, also used in various
40
# other places throughout the built documents.
42
# The short X.Y version.
44
# The full version, including alpha/beta/rc tags.
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
# If true, '()' will be appended to :func: etc. cross-reference text.
57
#add_function_parentheses = True
59
# If true, the current module name will be prepended to all description
60
# unit titles (such as .. function::).
61
#add_module_names = True
63
# If true, sectionauthor and moduleauthor directives will be shown in the
64
# output. They are ignored by default.
67
# The name of the Pygments (syntax highlighting) style to use.
68
pygments_style = 'sphinx'
71
# Options for HTML output
72
# -----------------------
74
# The style sheet to use for HTML and HTML Help pages. A file of that name
75
# must exist either in Sphinx' static/ path, or in one of the custom paths
76
# given in html_static_path.
77
html_style = 'default.css'
79
# Add any paths that contain custom static files (such as style sheets) here,
80
# relative to this directory. They are copied after the builtin static files,
81
# so a file named "default.css" will overwrite the builtin "default.css".
82
html_static_path = ['.static']
84
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
85
# using the given strftime format.
86
html_last_updated_fmt = '%b %d, %Y'
88
# If true, SmartyPants will be used to convert quotes and dashes to
89
# typographically correct entities.
90
#html_use_smartypants = True
92
# Content template for the index page.
95
# Custom sidebar templates, maps document names to template names.
98
# Additional templates that should be rendered to pages, maps page names to
100
#html_additional_pages = {}
102
# If false, no module index is generated.
103
#html_use_modindex = True
105
# If true, the reST sources are included in the HTML build as _sources/<name>.
106
#html_copy_source = True
108
# Output file base name for HTML help builder.
109
htmlhelp_basename = 'Mayavi2doc'
111
# A logo displayed in the html sidebar.
112
html_logo = 'mayavi-logo.png'
114
# Options for LaTeX output
115
# ------------------------
117
# The paper size ('letter' or 'a4').
118
#latex_paper_size = 'letter'
120
# The font size ('10pt', '11pt' or '12pt').
121
#latex_font_size = '10pt'
123
# Grouping the document tree into LaTeX files. List of tuples
124
# (source start file, target name, title, author, document class [howto/manual]).
125
latex_documents = [('index', 'mayavi_user_guide.tex', 'Mayavi2 User Guide',
126
'Prabhu Ramachandran, Gael Varoquaux', 'manual')]
128
# Additional stuff for the LaTeX preamble.
130
\definecolor{VerbatimColor}{rgb}{0.95,1,0.833}
131
\definecolor{VerbatimBorderColor}{rgb}{0.6,0.6,0.6}
134
# A logo displayed on the cover page.
135
latex_logo = 'mayavi-banner.jpg'
137
# Documents to append as an appendix to all manuals.
138
#latex_appendices = []
140
# If false, no module index is generated.
141
#latex_use_modindex = True
added
removed
enthought.mayavi/docs/source/conf.py
