79 lines
2.0 KiB
Plaintext
79 lines
2.0 KiB
Plaintext
|
[epydoc]
|
||
|
|
|
||
|
|
# Information about the project.
|
||
|
|
name: Netzob
|
||
|
|
url: http://www.netzob.org/
|
||
|
|
|
||
|
|
# Definition of the main package of Netzob
|
||
|
|
modules: netzob
|
||
|
|
|
||
|
|
# Generate HTML documentation in the doc/api directory
|
||
|
|
output: html
|
||
|
|
target: doc/api/
|
||
|
|
|
||
|
|
# An integer indicating how verbose epydoc should be. The default
|
||
|
|
# value is 0; negative values will supress warnings and errors;
|
||
|
|
# positive values will give more verbose output.
|
||
|
|
verbosity: 1
|
||
|
|
|
||
|
|
# A boolean value indicating that Epydoc should show a tracaback
|
||
|
|
# in case of unexpected error. By default don't show tracebacks
|
||
|
|
debug: 0
|
||
|
|
|
||
|
|
# If True, don't try to use colors or cursor control when doing
|
||
|
|
# textual output. The default False assumes a rich text prompt
|
||
|
|
simple-term: 1
|
||
|
|
|
||
|
|
|
||
|
|
### Generation options
|
||
|
|
|
||
|
|
# The default markup language for docstrings, for modules that do
|
||
|
|
# not define __docformat__. Defaults to epytext.
|
||
|
|
docformat: epytext
|
||
|
|
|
||
|
|
# Whether or not parsing should be used to examine objects.
|
||
|
|
parse: yes
|
||
|
|
|
||
|
|
# Whether or not introspection should be used to examine objects.
|
||
|
|
introspect: yes
|
||
|
|
|
||
|
|
# Don't examine in any way the modules whose dotted name match this
|
||
|
|
# regular expression pattern.
|
||
|
|
#exclude
|
||
|
|
|
||
|
|
# Don't perform introspection on the modules whose dotted name match this
|
||
|
|
# regular expression pattern.
|
||
|
|
#exclude-introspect
|
||
|
|
|
||
|
|
# Don't perform parsing on the modules whose dotted name match this
|
||
|
|
# regular expression pattern.
|
||
|
|
#exclude-parse
|
||
|
|
|
||
|
|
# The format for showing inheritance objects.
|
||
|
|
# It should be one of: 'grouped', 'listed', 'included'.
|
||
|
|
inheritance: listed
|
||
|
|
|
||
|
|
# Whether or not to inclue private variables. (Even if included,
|
||
|
|
# private variables will be hidden by default.)
|
||
|
|
private: yes
|
||
|
|
|
||
|
|
# Whether or not to list each module's imports.
|
||
|
|
imports: yes
|
||
|
|
|
||
|
|
# Whether or not to include syntax highlighted source code in
|
||
|
|
# the output (HTML only).
|
||
|
|
sourcecode: yes
|
||
|
|
|
||
|
|
# Whether or not to includea a page with Epydoc log, containing
|
||
|
|
# effective option at the time of generation and the reported logs.
|
||
|
|
include-log: no
|
||
|
|
|
||
|
|
frames: no
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# Include all automatically generated graphs. These graphs are
|
||
|
|
# generated using Graphviz dot.
|
||
|
|
graph: all
|
||
|
|
dotpath: /usr/bin/dot
|