comparison doc/conf.py @ 908:9472d234db2e

Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
author fsavard
date Thu, 18 Mar 2010 11:33:49 -0400
parents
children 8837535006f1
comparison
equal deleted inserted replaced
904:08b37147dec1 908:9472d234db2e
1 # -*- coding: utf-8 -*-
2 #
3 # theano documentation build configuration file, created by
4 # sphinx-quickstart on Tue Oct 7 16:34:06 2008.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
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).
10 #
11 # All configuration values have a default value; values that are commented out
12 # serve to show the default value.
13
14 import sys, os
15
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('some/directory'))
20
21 # General configuration
22 # ---------------------
23
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', 'sphinx.ext.todo', 'ext']
27
28 todo_include_todos = True
29
30 try:
31 from sphinx.ext import pngmath
32 extensions.append('sphinx.ext.pngmath')
33 except ImportError:
34 pass
35
36
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ['.templates']
39
40 # The suffix of source filenames.
41 source_suffix = '.txt'
42
43 # The master toctree document.
44 master_doc = 'index'
45
46 # General substitutions.
47 project = 'Theano'
48 copyright = '2008--2009, LISA lab'
49
50 # The default replacements for |version| and |release|, also used in various
51 # other places throughout the built documents.
52 #
53 # The short X.Y version.
54 version = '0.1'
55 # The full version, including alpha/beta/rc tags.
56 release = '0.1'
57
58 # There are two options for replacing |today|: either, you set today to some
59 # non-false value, then it is used:
60 #today = ''
61 # Else, today_fmt is used as the format for a strftime call.
62 today_fmt = '%B %d, %Y'
63
64 # List of documents that shouldn't be included in the build.
65 #unused_docs = []
66
67 # List of directories, relative to source directories, that shouldn't be searched
68 # for source files.
69 exclude_dirs = ['images', 'scripts', 'sandbox']
70
71 # The reST default role (used for this markup: `text`) to use for all documents.
72 #default_role = None
73
74 # If true, '()' will be appended to :func: etc. cross-reference text.
75 #add_function_parentheses = True
76
77 # If true, the current module name will be prepended to all description
78 # unit titles (such as .. function::).
79 #add_module_names = True
80
81 # If true, sectionauthor and moduleauthor directives will be shown in the
82 # output. They are ignored by default.
83 #show_authors = False
84
85 # The name of the Pygments (syntax highlighting) style to use.
86 pygments_style = 'sphinx'
87
88
89 # Options for HTML output
90 # -----------------------
91
92 # The style sheet to use for HTML and HTML Help pages. A file of that name
93 # must exist either in Sphinx' static/ path, or in one of the custom paths
94 # given in html_static_path.
95 #html_style = 'default.css'
96 html_theme = 'sphinxdoc'
97
98 # The name for this set of Sphinx documents. If None, it defaults to
99 # "<project> v<release> documentation".
100 #html_title = None
101
102 # A shorter title for the navigation bar. Default is the same as html_title.
103 #html_short_title = None
104
105 # The name of an image file (within the static path) to place at the top of
106 # the sidebar.
107 #html_logo = 'images/theano_logo-200x67.png'
108 html_logo = 'images/theano_logo_allblue_200x46.png'
109
110 # The name of an image file (within the static path) to use as favicon of the
111 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
112 # pixels large.
113 #html_favicon = None
114
115 # Add any paths that contain custom static files (such as style sheets) here,
116 # relative to this directory. They are copied after the builtin static files,
117 # so a file named "default.css" will overwrite the builtin "default.css".
118 html_static_path = ['.static', 'images']
119
120 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
121 # using the given strftime format.
122 html_last_updated_fmt = '%b %d, %Y'
123
124 # If true, SmartyPants will be used to convert quotes and dashes to
125 # typographically correct entities.
126 html_use_smartypants = True
127
128 # Custom sidebar templates, maps document names to template names.
129 #html_sidebars = {}
130
131 # Additional templates that should be rendered to pages, maps page names to
132 # template names.
133 #html_additional_pages = {}
134
135 # If false, no module index is generated.
136 #html_use_modindex = True
137
138 # If false, no index is generated.
139 #html_use_index = True
140
141 # If true, the index is split into individual pages for each letter.
142 #html_split_index = False
143
144 # If true, the reST sources are included in the HTML build as _sources/<name>.
145 #html_copy_source = True
146
147 # If true, an OpenSearch description file will be output, and all pages will
148 # contain a <link> tag referring to it. The value of this option must be the
149 # base URL from which the finished HTML is served.
150 #html_use_opensearch = ''
151
152 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
153 #html_file_suffix = ''
154
155 # Output file base name for HTML help builder.
156 htmlhelp_basename = 'theanodoc'
157
158
159 # Options for LaTeX output
160 # ------------------------
161
162 # The paper size ('letter' or 'a4').
163 #latex_paper_size = 'letter'
164
165 # The font size ('10pt', '11pt' or '12pt').
166 latex_font_size = '11pt'
167
168 # Grouping the document tree into LaTeX files. List of tuples
169 # (source start file, target name, title, author, document class [howto/manual]).
170 latex_documents = [
171 ('index', 'theano.tex', 'theano Documentation',
172 'LISA lab, University of Montreal', 'manual'),
173 ]
174
175 # The name of an image file (relative to this directory) to place at the top of
176 # the title page.
177 #latex_logo = 'images/snake_theta2-trans.png'
178 latex_logo = None
179
180 # For "manual" documents, if this is true, then toplevel headings are parts,
181 # not chapters.
182 #latex_use_parts = False
183
184 # Additional stuff for the LaTeX preamble.
185 #latex_preamble = ''
186
187 # Documents to append as an appendix to all manuals.
188 #latex_appendices = []
189
190 # If false, no module index is generated.
191 #latex_use_modindex = True