docs/epydoc.config

   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: apt_p2p apt_p2p_Khashmir test.py
   7
   8 # The type of output that should be generated.  Should be one
   9 # of: html, text, latex, dvi, ps, pdf.
  10 output: html
  11
  12 # The path to the output directory.  May be relative or absolute.
  13 target: docs/html/
  14
  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.
  18 verbosity: 0
  19
  20 # A boolean value indicating that Epydoc should show a tracaback
  21 # in case of unexpected error. By default don't show tracebacks
  22 debug: 0
  23
  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
  26 simple-term: 0
  27
  28
  29 ### Generation options
  30
  31 # The default markup language for docstrings, for modules that do
  32 # not define __docformat__.  Defaults to epytext.
  33 docformat: epytext
  34
  35 # Whether or not parsing should be used to examine objects.
  36 parse: yes
  37
  38 # Whether or not introspection should be used to examine objects.
  39 introspect: yes
  40
  41 # Don't examine in any way the modules whose dotted name match this
  42 # regular expression pattern.
  43 #exclude
  44
  45 # Don't perform introspection on the modules whose dotted name match this
  46 # regular expression pattern.
  47 #exclude-introspect
  48
  49 # Don't perform parsing on the modules whose dotted name match this
  50 # regular expression pattern.
  51 #exclude-parse
  52
  53 # The format for showing inheritance objects.
  54 # It should be one of: 'grouped', 'listed', 'included'.
  55 inheritance: grouped
  56
  57 # Whether or not to inclue private variables.  (Even if included,
  58 # private variables will be hidden by default.)
  59 private: yes
  60
  61 # Whether or not to list each module's imports.
  62 imports: yes
  63
  64 # Whether or not to include syntax highlighted source code in
  65 # the output (HTML only).
  66 sourcecode: yes
  67
  68 # Whether or not to includea a page with Epydoc log, containing
  69 # effective option at the time of generation and the reported logs.
  70 include-log: yes
  71
  72
  73 ### Output options
  74
  75 # The documented project's name.
  76 name: Apt-P2P
  77
  78 # The CSS stylesheet for HTML output.  Can be the name of a builtin
  79 # stylesheet, or the name of a file.
  80 css: white
  81
  82 # The documented project's URL.
  83 url: http://www.camrdale.org/apt-p2p.html
  84
  85 # HTML code for the project link in the navigation bar.  If left
  86 # unspecified, the project link will be generated based on the
  87 # project's name and URL.
  88 #link: <a href="somewhere">My Cool Project</a>
  89
  90 # The "top" page for the documentation.  Can be a URL, the name
  91 # of a module or class, or one of the special names "trees.html",
  92 # "indices.html", or "help.html"
  93 #top: os.path
  94
  95 # An alternative help file.  The named file should contain the
  96 # body of an HTML file; navigation bars will be added to it.
  97 #help: my_helpfile.html
  98
  99 # Whether or not to include a frames-based table of contents.
 100 frames: yes
 101
 102 # Whether each class should be listed in its own section when
 103 # generating LaTeX or PDF output.
 104 separate-classes: no
 105
 106
 107 ### API linking options
 108
 109 # Define a new API document.  A new interpreted text role
 110 # will be created
 111 #external-api: epydoc
 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.
 117 #external-api-root: epydoc:http://epydoc.sourceforge.net/api
 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",
 125 # "umlclass".  Use "all" to include all graph types
 126 graph: all
 127
 128 # The path to the Graphviz "dot" executable, used to generate
 129 # graphs.
 130 #dotpath: /usr/local/bin/dot
 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: docs/pstat/debtorrent-client.pstat
 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
 143
 144 ### Return value options
 145
 146 # The condition upon which Epydoc should exit with a non-zero
 147 # exit status. Possible values are error, warning, docstring_warning
 148 #fail-on: error
 149