-
Notifications
You must be signed in to change notification settings - Fork 3
/
.epydoc
105 lines (84 loc) · 3.02 KB
/
.epydoc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
[epydoc] # Epydoc section marker (required by ConfigParser)
# modules
# The list of objects to document. Objects can be named using
# dotted names, module filenames, or package directory names.
# Alases for this option include "objects" and "values".
modules: interative.py,heimpt.py,disseminate.py,prepare.py,globals.py,merge.py,tools/archive/postProcess.py,disseminate.py,debug.py
# output
# The type of output that should be generated. Should be one
# of: html, text, latex, dvi, ps, pdf.
output: html
# target
# The path to the output directory. May be relative or absolute.
target: apidoc/
# docformat
# The default markup language for docstrings, for modules that do
# not define __docformat__. Defaults to epytext.
docformat: epytext
# css
# The CSS stylesheet for HTML output. Can be the name of a builtin
# stylesheet, or the name of a file.
css: white
# name
# The documented project's name.
name:heimpt
# url
# The documented project's URL.
url: https://github.com/withanage/heimpt
# link
# HTML code for the project link in the navigation bar. If left
# unspecified, the project link will be generated based on the
# project's name and URL.
link: <a href="https://github.com/withanage/heimpt">heiMPT</a>
# top
# The "top" page for the documentation. Can be a URL, the name
# of a module or class, or one of the special names "trees.html",
# "indices.html", or "help.html"
# top: os.path
# help
# An alternative help file. The named file should contain the
# body of an HTML file; navigation bars will be added to it.
#help: help.html
# frames
# Whether or not to include a frames-based table of contents.
frames: yes
# private
# Whether or not to inclue private variables. (Even if included,
# private variables will be hidden by default.)
private: yes
# imports
# Whether or not to list each module's imports.
imports: no
# verbosity
# 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: 0
# parse
# Whether or not parsing should be used to examine objects.
parse: yes
# introspect
# Whether or not introspection should be used to examine objects.
introspect: yes
# graph
# The list of graph types that should be automatically included
# in the output. Graphs are generated using the Graphviz "dot"
# executable. Graph types include: "classtree", "callgraph",
# "umlclass". Use "all" to include all graph types
graph: all
# dotpath
# The path to the Graphviz "dot" executable, used to generate
# graphs.
dotpath:dot
# sourcecode
# Whether or not to include syntax highlighted source code in
# the output (HTML only).
sourcecode: yes
# pstat
# The name of one or more pstat files (generated by the profile
# or hotshot module). These are used to generate call graphs.
# pstat: profile.out
# separate-classes
# Whether each class should be listed in its own section when
# generating LaTeX or PDF output.
separate-classes: no