1 [epydoc] # Epydoc section marker (required by ConfigParser)
3 # The list of objects to document. Objects can be named using
4 # dotted names, module filenames, or package directory names.
5 # Alases for this option include "objects" and "values".
6 modules: apt_p2p apt_p2p_Khashmir apt-p2p.py test.py
8 # The type of output that should be generated. Should be one
9 # of: html, text, latex, dvi, ps, pdf.
12 # The path to the output directory. May be relative or absolute.
15 # An integer indicating how verbose epydoc should be. The default
16 # value is 0; negative values will supress warnings and errors;
17 # positive values will give more verbose output.
20 # A boolean value indicating that Epydoc should show a tracaback
21 # in case of unexpected error. By default don't show tracebacks
24 # If True, don't try to use colors or cursor control when doing
25 # textual output. The default False assumes a rich text prompt
29 ### Generation options
31 # The default markup language for docstrings, for modules that do
32 # not define __docformat__. Defaults to epytext.
35 # Whether or not parsing should be used to examine objects.
38 # Whether or not introspection should be used to examine objects.
41 # Don't examine in any way the modules whose dotted name match this
42 # regular expression pattern.
45 # Don't perform introspection on the modules whose dotted name match this
46 # regular expression pattern.
49 # Don't perform parsing on the modules whose dotted name match this
50 # regular expression pattern.
53 # The format for showing inheritance objects.
54 # It should be one of: 'grouped', 'listed', 'included'.
57 # Whether or not to inclue private variables. (Even if included,
58 # private variables will be hidden by default.)
61 # Whether or not to list each module's imports.
64 # Whether or not to include syntax highlighted source code in
65 # the output (HTML only).
68 # Whether or not to includea a page with Epydoc log, containing
69 # effective option at the time of generation and the reported logs.
75 # The documented project's name.
78 # The CSS stylesheet for HTML output. Can be the name of a builtin
79 # stylesheet, or the name of a file.
82 # The documented project's URL.
83 url: http://www.camrdale.org/apt-p2p/
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="somewhere">My Cool Project</a>
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"
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
99 # Whether or not to include a frames-based table of contents.
102 # Whether each class should be listed in its own section when
103 # generating LaTeX or PDF output.
107 ### API linking options
109 # Define a new API document. A new interpreted text role
111 #external-api: epydoc
113 # Use the records in this file to resolve objects in the API named NAME.
114 #external-api-file: epydoc:api-objects.txt
116 # Use this URL prefix to configure the string returned for external API.
117 #external-api-root: epydoc:http://epydoc.sourceforge.net/api
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 # "umlclass". Use "all" to include all graph types
128 # The path to the Graphviz "dot" executable, used to generate
130 #dotpath: /usr/local/bin/dot
132 # The name of one or more pstat files (generated by the profile
133 # or hotshot module). These are used to generate call graphs.
134 #pstat: docs/pstat/debtorrent-client.pstat
136 # Specify the font used to generate Graphviz graphs.
137 # (e.g., helvetica or times).
138 graph-font: Helvetica
140 # Specify the font size used to generate Graphviz graphs.
144 ### Return value options
146 # The condition upon which Epydoc should exit with a non-zero
147 # exit status. Possible values are error, warning, docstring_warning