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 | # Alases for this option include "objects" and "values". |
---|
6 | modules: mystic/mystic, mystic/models, mystic/math, mystic/cache |
---|
7 | #modules: mystic/mystic |
---|
8 | |
---|
9 | # The type of output that should be generated. Should be one |
---|
10 | # of: html, text, latex, dvi, ps, pdf. |
---|
11 | output: html |
---|
12 | #output: pdf |
---|
13 | |
---|
14 | # The path to the output directory. May be relative or absolute. |
---|
15 | target: html |
---|
16 | |
---|
17 | # An integer indicating how verbose epydoc should be. The default value is 0 |
---|
18 | # Negative values will supress 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 tracaback |
---|
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 | |
---|
31 | ### Generation options |
---|
32 | |
---|
33 | # The default markup language for docstrings, for modules that do |
---|
34 | # not define __docformat__. Defaults to epytext. |
---|
35 | # docformat: restructuredtext |
---|
36 | |
---|
37 | # Whether or not parsing should be used to examine objects. |
---|
38 | parse: yes |
---|
39 | |
---|
40 | # Whether or not introspection should be used to examine objects. |
---|
41 | introspect: yes |
---|
42 | |
---|
43 | # Don't examine in any way the modules whose dotted name match this |
---|
44 | # regular expression pattern. |
---|
45 | #exclude: mystic.const |
---|
46 | |
---|
47 | # Don't perform introspection on the modules whose dotted name match this |
---|
48 | # regular expression pattern. |
---|
49 | #exclude-introspect |
---|
50 | |
---|
51 | # Don't perform parsing on the modules whose dotted name match this |
---|
52 | # regular expression pattern. |
---|
53 | #exclude-parse |
---|
54 | |
---|
55 | # The format for showing inheritance objects. |
---|
56 | # It should be one of: 'grouped', 'listed', 'included'. |
---|
57 | inheritance: listed |
---|
58 | |
---|
59 | # Whether or not to inclue private variables. (Even if included, |
---|
60 | # private variables will be hidden by default.) |
---|
61 | private: no |
---|
62 | |
---|
63 | # Whether or not to list each module's imports. |
---|
64 | imports: no |
---|
65 | |
---|
66 | # Whether or not to include syntax highlighted source code in |
---|
67 | # the output (HTML only). |
---|
68 | sourcecode: yes |
---|
69 | |
---|
70 | # Whether or not to includea a page with Epydoc log, containing |
---|
71 | # effective option at the time of generation and the reported logs. |
---|
72 | include-log: no |
---|
73 | |
---|
74 | |
---|
75 | ### Output options |
---|
76 | |
---|
77 | # The documented project's name. |
---|
78 | name: mystic |
---|
79 | |
---|
80 | # The CSS stylesheet for HTML output. Can be the name of a builtin |
---|
81 | # stylesheet, or the name of a file. |
---|
82 | css: white |
---|
83 | |
---|
84 | # The documented project's URL. |
---|
85 | url: http://dev.danse.us/trac/mystic |
---|
86 | |
---|
87 | # HTML code for the project link in the navigation bar. If left |
---|
88 | # unspecified, the project link will be generated based on the |
---|
89 | # project's name and URL. |
---|
90 | link: <a href="http://dev.danse.us/trac/mystic">mystic</a> |
---|
91 | |
---|
92 | # The "top" page for the documentation. Can be a URL, the name |
---|
93 | # of a module or class, or one of the special names "trees.html", |
---|
94 | # "indices.html", or "help.html" |
---|
95 | top: mystic |
---|
96 | |
---|
97 | # An alternative help file. The named file should contain the |
---|
98 | # body of an HTML file; navigation bars will be added to it. |
---|
99 | #help: my_helpfile.html |
---|
100 | |
---|
101 | # Whether or not to include a frames-based table of contents. |
---|
102 | frames: no |
---|
103 | |
---|
104 | # Whether each class should be listed in its own section when |
---|
105 | # generating LaTeX or PDF output. |
---|
106 | separate-classes: no |
---|
107 | |
---|
108 | |
---|
109 | ### API linking options |
---|
110 | |
---|
111 | # Define a new API document. A new interpreted text role will be created |
---|
112 | external-api: mystic |
---|
113 | |
---|
114 | # Use the records in this file to resolve objects in the API named NAME. |
---|
115 | #external-api-file: epydoc:api-objects.txt |
---|
116 | |
---|
117 | # Use this URL prefix to configure the string returned for external API. |
---|
118 | external-api-root: mystic:http://dev.danse.us/trac/mystic |
---|
119 | |
---|
120 | |
---|
121 | ### Graph options |
---|
122 | |
---|
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","umlclasstree". |
---|
126 | # Use "all" to include all graph types |
---|
127 | graph: umlclasstree |
---|
128 | |
---|
129 | # The path to the Graphviz "dot" executable, used to generate graphs. |
---|
130 | #dotpath: /cygdrive/c/cygwin/usr/local/graphviz/bin/ |
---|
131 | |
---|
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: profile.out |
---|
135 | |
---|
136 | # Specify the font used to generate Graphviz graphs. |
---|
137 | # (e.g., helvetica or times). |
---|
138 | graph-font: Helvetica |
---|
139 | |
---|
140 | # Specify the font size used to generate Graphviz graphs. |
---|
141 | graph-font-size: 10 |
---|
142 | #graph-image-format: png |
---|
143 | #graph-image-format: svg |
---|
144 | |
---|
145 | ### Return value options |
---|
146 | |
---|
147 | # The condition upon which Epydoc should exit with a non-zero exit status. |
---|
148 | # Possible values are error, warning, docstring_warning |
---|
149 | fail-on: error |
---|