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".
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.
33
docformat: reStructuredText
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.
46
# Don't perform introspection on the modules whose dotted name match this
47
# regular expression pattern.
50
# Don't perform parsing on the modules whose dotted name match this
51
# regular expression pattern.
54
# The format for showing inheritance objects.
55
# It should be one of: 'grouped', 'listed', 'included'.
58
# Whether or not to inclue private variables. (Even if included,
59
# private variables will be hidden by default.)
62
# Whether or not to list each module's imports.
65
# Whether or not to include syntax highlighted source code in
66
# the output (HTML only).
69
# Whether or not to include a a page with Epydoc log, containing
70
# effective option at the time of generation and the reported logs.
76
# The documented project's name.
77
name: Global Arrays for Python
79
# The documented project's URL.
80
url: http://www.emsl.pnl.gov/docs/global/
82
# The CSS stylesheet for HTML output. Can be the name of a builtin
83
# stylesheet, or the name of a file.
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>
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"
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
100
# Whether or not to include a frames-based table of contents.
103
# Whether each class should be listed in its own section when
104
# generating LaTeX or PDF output.
108
### API linking options
110
# Define a new API document. A new interpreted text role
112
#external-api: epydoc
114
# Use the records in this file to resolve objects in the API named NAME.
115
#external-api-file: epydoc:api-objects.txt
117
# Use this URL prefix to configure the string returned for external API.
118
#external-api-root: epydoc:http://epydoc.sourceforge.net/api
123
# The list of graph types that should be automatically included
124
# in the output. Graphs are generated using the Graphviz "dot"
125
# executable. Graph types include: "classtree", "callgraph",
126
# "umlclasstree". Use "all" to include all graph types
129
# The path to the Graphviz "dot" executable, used to generate
131
#dotpath: /usr/local/bin/dot
133
# The name of one or more pstat files (generated by the profile
134
# or hotshot module). These are used to generate call graphs.
137
# Specify the font used to generate Graphviz graphs.
138
# (e.g., helvetica or times).
139
graph-font: Helvetica
141
# Specify the font size used to generate Graphviz graphs.
145
### Return value options
147
# The condition upon which Epydoc should exit with a non-zero
148
# exit status. Possible values are error, warning, docstring_warning