Mercurial > pylearn
annotate doc/api/epydoc.conf @ 1488:440e1afe28a3
Fix a mistake in .hgignore.
author | valentin Bisson <bissonva@iro.umontreal.ca> |
---|---|
date | Fri, 22 Jul 2011 11:41:32 -0400 |
parents | 9472d234db2e |
children |
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 # TODO: |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
2 # Get all graphs to work! |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
3 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
4 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
5 [epydoc] # Epydoc section marker (required by ConfigParser) |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
6 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
7 # The list of objects to document. Objects can be named using |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
8 # dotted names, module filenames, or package directory names. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
9 # Alases for this option include "objects" and "values". |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
10 modules: pylearn |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
11 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
12 # The type of output that should be generated. Should be one |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
13 # of: html, text, latex, dvi, ps, pdf. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
14 output: html |
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 # An integer indicating how verbose epydoc should be. The default |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
17 # value is 0; negative values will supress warnings and errors; |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
18 # positive values will give more verbose output. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
19 verbosity: 1 |
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 # A boolean value indicating that Epydoc should show a tracaback |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
22 # in case of unexpected error. By default don't show tracebacks |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
23 debug: 1 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
24 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
25 # If True, don't try to use colors or cursor control when doing |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
26 # textual output. The default False assumes a rich text prompt |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
27 simple-term: 0 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
28 |
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 ### Generation options |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
31 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
32 # The default markup language for docstrings, for modules that do |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
33 # not define __docformat__. Defaults to epytext. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
34 docformat: epytext |
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 # Whether or not parsing should be used to examine objects. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
37 parse: yes |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
38 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
39 # Whether or not introspection should be used to examine objects. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
40 introspect: yes |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
41 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
42 # Don't examine in any way the modules whose dotted name match this |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
43 # regular expression pattern. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
44 #exclude |
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 # Don't perform introspection on the modules whose dotted name match this |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
47 # regular expression pattern. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
48 #exclude-introspect |
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 # Don't perform parsing on the modules whose dotted name match this |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
51 # regular expression pattern. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
52 #exclude-parse |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
53 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
54 # The format for showing inheritance objects. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
55 # It should be one of: 'grouped', 'listed', 'included'. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
56 inheritance: grouped |
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 # Whether or not to inclue private variables. (Even if included, |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
59 # private variables will be hidden by default.) |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
60 private: yes |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
61 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
62 # Whether or not to list each module's imports. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
63 imports: yes |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
64 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
65 # Whether or not to include syntax highlighted source code in |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
66 # the output (HTML only). |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
67 sourcecode: yes |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
68 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
69 # Whether or not to includea a page with Epydoc log, containing |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
70 # effective option at the time of generation and the reported logs. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
71 include-log: yes |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
72 |
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 ### Output options |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
75 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
76 # The documented project's name. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
77 name: Pylearn |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
78 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
79 # The CSS stylesheet for HTML output. Can be the name of a builtin |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
80 # stylesheet, or the name of a file. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
81 css: white |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
82 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
83 # The documented project's URL. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
84 url: http://deeplearning.net/software/pylearn/ |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
85 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
86 # HTML code for the project link in the navigation bar. If left |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
87 # unspecified, the project link will be generated based on the |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
88 # project's name and URL. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
89 #link: <a href="somewhere">My Cool Project</a> |
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 # The "top" page for the documentation. Can be a URL, the name |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
92 # of a module or class, or one of the special names "trees.html", |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
93 # "indices.html", or "help.html" |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
94 #top: os.path |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
95 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
96 # An alternative help file. The named file should contain the |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
97 # body of an HTML file; navigation bars will be added to it. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
98 #help: my_helpfile.html |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
99 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
100 # Whether or not to include a frames-based table of contents. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
101 #frames: yes |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
102 frames: no |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
103 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
104 # Whether each class should be listed in its own section when |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
105 # generating LaTeX or PDF output. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
106 separate-classes: no |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
107 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
108 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
109 ### API linking options |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
110 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
111 # Define a new API document. A new interpreted text role |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
112 # will be created |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
113 #external-api: epydoc |
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 # Use the records in this file to resolve objects in the API named NAME. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
116 #external-api-file: epydoc:api-objects.txt |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
117 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
118 # Use this URL prefix to configure the string returned for external API. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
119 #external-api-root: epydoc:http://epydoc.sourceforge.net/api |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
120 # external-api: wiki doc |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
121 # external-api-root: wiki:http://lgcm.iro.umontreal.ca/theano/wiki/ doc:http://lgcm.iro.umontreal.ca/auto_theano/doc/ |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
122 # external-api-file: wiki:wiki.idx doc:doc/doc.idx |
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 ### Graph options |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
125 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
126 # The list of graph types that should be automatically included |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
127 # in the output. Graphs are generated using the Graphviz "dot" |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
128 # executable. Graph types include: "classtree", "callgraph", |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
129 # "umlclass". Use "all" to include all graph types |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
130 graph: all |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
131 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
132 # The path to the Graphviz "dot" executable, used to generate |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
133 # graphs. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
134 dotpath: /usr/bin/dot |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
135 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
136 # The name of one or more pstat files (generated by the profile |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
137 # or hotshot module). These are used to generate call graphs. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
138 #pstat: autotest.pstat |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
139 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
140 # Specify the font used to generate Graphviz graphs. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
141 # (e.g., helvetica or times). |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
142 graph-font: Helvetica |
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 # Specify the font size used to generate Graphviz graphs. |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
145 graph-font-size: 10 |
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 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
148 ### Return value options |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
149 |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
150 # The condition upon which Epydoc should exit with a non-zero |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
151 # exit status. Possible values are error, warning, docstring_warning |
9472d234db2e
Added basics for documentation with sphinx and epydoc, by copying files from the Theano/doc directory
fsavard
parents:
diff
changeset
|
152 #fail-on: error |