Mercurial > pylearn

comparison doc/api/epydoc.conf @ 908:9472d234db2e

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