Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100755 151 lines (109 sloc) 4.753 kb
7e84231 @volpino committing original project
volpino authored
1 [epydoc] # Epydoc section marker (required by ConfigParser)
2
3 # The list of objects to document. Objects can be named using
4 # dotted names, module filenames, or package directory names.
5 # Aliases for this option include "objects" and "values".
6 modules: gluon/*.py
7
8 # The type of output that should be generated. Should be one
9 # of: html, text, latex, dvi, ps, pdf.
10 #output: latex
11 output: html
12
13 # The path to the output directory. May be relative or absolute.
14 target: applications/examples/static/epydoc
15 #target: docs
16
17 # An integer indicating how verbose epydoc should be. The default
18 # value is 0; negative values will suppress warnings and errors;
19 # positive values will give more verbose output.
20 verbosity: 0
21
22 # A boolean value indicating that Epydoc should show a traceback
23 # in case of unexpected error. By default don't show tracebacks
24 debug: 0
25
26 # If True, don't try to use colors or cursor control when doing
27 # textual output. The default False assumes a rich text prompt
28 simple-term: 0
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: listed
57
58 # Whether or not to include 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: no
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 include a page with Epydoc log, containing
70 # effective option at the time of generation and the reported logs.
71 include-log: no
72
73 ### Output options
74
75 # The documented project's name.
76 name: web2py Web Framework
77
78 # The CSS stylesheet for HTML output. Can be the name of a built-in
79 # stylesheet, or the name of a file.
80 css: epydoc.css
81
82 # The documented project's URL.
83 url: http://www.web2py.com
84
85 # HTML code for the project link in the navigation bar. If left
86 # unspecified, the project link will be generated based on the
87 # project's name and URL.
88 # link: <a href="http://www.web2py.com">web2py</a>
89
90 # The "top" page for the documentation. Can be a URL, the name
91 # of a module or class, or one of the special names "trees.html",
92 # "indices.html", or "help.html"
93 #top: os.path
94
95 # An alternative help file. The named file should contain the
96 # body of an HTML file; navigation bars will be added to it.
97 #help: my_helpfile.html
98
99 # Whether or not to include a frames-based table of contents.
100 frames: yes
101
102 # Whether each class should be listed in its own section when
103 # generating LaTeX or PDF output.
104 separate-classes: no
105
106
107 ### API linking options
108
109 # Define a new API document. A new interpreted text role
110 # will be created
111 #external-api: epydoc
112
113 # Use the records in this file to resolve objects in the API named NAME.
114 #external-api-file: epydoc:api-objects.txt
115
116 # Use this URL prefix to configure the string returned for external API.
117 #external-api-root: epydoc:http://epydoc.sourceforge.net/api
118
119
120 ### Graph options
121
122 # The list of graph types that should be automatically included
123 # in the output. Graphs are generated using the Graphviz "dot"
124 # executable. Graph types include: "classtree", "callgraph",
125 # "umlclasstree". Use "all" to include all graph types
126 # graph: umlclasstree
127 # graph:
128
129 # The path to the Graphviz "dot" executable, used to generate
130 # graphs.
131 #dotpath: C:/home/graphviz/bin/dot.exe
132 #dotpath: /Applications/Graphviz.app/Contents/MacOS/dot
133
134 # The name of one or more pstat files (generated by the profile
135 # or hotshot module). These are used to generate call graphs.
136 #pstat: profile.out
137
138 # Specify the font used to generate Graphviz graphs.
139 # (e.g., helvetica or times).
140 # graph-font: Bitstream Vera Sans
141 graph-font: Helvetica
142
143 # Specify the font size used to generate Graphviz graphs.
144 graph-font-size: 10
145
146 ### Return value options
147
148 # The condition upon which Epydoc should exit with a non-zero
149 # exit status. Possible values are error, warning, docstring_warning
150 #fail-on: error
Something went wrong with that request. Please try again.