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