source: sasview/park-1.2.1/park.epydoc @ e9bd127

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since e9bd127 was 4025019, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

Adding util and park

  • Property mode set to 100755
File size: 4.4 KB
Line 
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".
6modules: park
7
8# The type of output that should be generated.  Should be one
9# of: html, text, latex, dvi, ps, pdf.
10#output: html
11output: pdf
12
13# The path to the output directory.  May be relative or absolute.
14target: build/html/
15
16# An integer indicating how verbose epydoc should be. The default value is 0
17# Negative values will supress warnings and errors
18# Positive values will give more verbose output.
19verbosity: 0
20
21# A boolean value indicating that Epydoc should show a tracaback
22# in case of unexpected error. By default don't show tracebacks
23debug: 0
24
25# If True, don't try to use colors or cursor control when doing
26# textual output. The default False assumes a rich text prompt
27simple-term: 0
28
29
30### Generation options
31
32# The default markup language for docstrings, for modules that do
33# not define __docformat__.  Defaults to epytext.
34docformat: restructuredtext
35
36# Whether or not parsing should be used to examine objects.
37parse: yes
38
39# Whether or not introspection should be used to examine objects.
40introspect: yes
41
42# Don't examine in any way the modules whose dotted name match this
43# regular expression pattern.
44#exclude
45
46# Don't perform introspection on the modules whose dotted name match this
47# regular expression pattern.
48#exclude-introspect
49
50# Don't perform parsing on the modules whose dotted name match this
51# regular expression pattern.
52#exclude-parse
53
54# The format for showing inheritance objects.
55# It should be one of: 'grouped', 'listed', 'included'.
56inheritance: listed
57
58# Whether or not to inclue private variables.  (Even if included,
59# private variables will be hidden by default.)
60private: no
61
62# Whether or not to list each module's imports.
63imports: no
64
65# Whether or not to include syntax highlighted source code in
66# the output (HTML only).
67sourcecode: yes
68
69# Whether or not to includea a page with Epydoc log, containing
70# effective option at the time of generation and the reported logs.
71include-log: no
72
73
74### Output options
75
76# The documented project's name.
77name: PARK
78
79# The CSS stylesheet for HTML output.  Can be the name of a builtin
80# stylesheet, or the name of a file.
81css: white
82
83# The documented project's URL.
84url: http://www.reflectometry.org/danse/park
85
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.
89link: <a href="http://reflectometry.org/danse">Reflectometry</a>
90
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"
94#top: os.path
95
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
99
100# Whether or not to include a frames-based table of contents.
101frames: no
102
103# Whether each class should be listed in its own section when
104# generating LaTeX or PDF output.
105separate-classes: no
106
107
108### API linking options
109
110# Define a new API document.  A new interpreted text role will be created
111external-api: park
112
113# Use the records in this file to resolve objects in the API named NAME.
114#external-api-file: epydoc:api-objects.txt
115
116# Use this URL prefix to configure the string returned for external API.
117external-api-root: park:http://www.reflectometry.org/danse/park
118
119
120### Graph options
121
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","umlclasstree".
125# Use "all" to include all graph types
126graph: umlclasstree
127
128# The path to the Graphviz "dot" executable, used to generate graphs.
129#dotpath: /cygdrive/c/cygwin/usr/local/graphviz/bin/
130
131# The name of one or more pstat files (generated by the profile
132# or hotshot module). These are used to generate call graphs.
133#pstat: profile.out
134
135# Specify the font used to generate Graphviz graphs.
136# (e.g., helvetica or times).
137graph-font: Helvetica
138
139# Specify the font size used to generate Graphviz graphs.
140graph-font-size: 10
141graph-image-format: svg
142
143### Return value options
144
145# The condition upon which Epydoc should exit with a non-zero exit status.
146# Possible values are error, warning, docstring_warning
147fail-on: error
Note: See TracBrowser for help on using the repository browser.