epydoc.html.cfg

   1 [epydoc]
   2
   3 # modules
   4 #   The list of objects to document.  Objects can be named using
   5 #   dotted names, module filenames, or package directory names.
   6 #   Alases for this option include "objects" and "values".
   7 modules: enkel
   8
   9 # output
  10 #   The type of output that should be generated.  Should be one
  11 #   of: html, text, latex, dvi, ps, pdf.
  12 output: html
  13
  14 # target
  15 #   The path to the output directory.  May be relative or absolute.
  16 target: apidoc/
  17
  18 # docformat
  19 #   The default markup language for docstrings, for modules that do
  20 #   not define __docformat__.  Defaults to epytext.
  21 docformat: epytext
  22
  23 # css
  24 #   The CSS stylesheet for HTML output.  Can be the name of a builtin
  25 #   stylesheet, or the name of a file.
  26 #css: blue
  27
  28 # name
  29 #   The documented project's name.
  30 name: enkel
  31
  32 # url
  33 #   The documented project's URL.
  34 url: http://leela.xangell.com:3000/enkel
  35
  36
  37 # frames
  38 #   Whether or not to include a frames-based table of contents.
  39 frames: yes
  40
  41 # private
  42 #   Whether or not to inclue private variables.  (Even if included,
  43 #   private variables will be hidden by default.)
  44 private: no
  45
  46 # imports
  47 #   Whether or not to list each module's imports.
  48 imports: no
  49
  50 # verbosity
  51 #   An integer indicating how verbose epydoc should be.  The default
  52 #   value is 0; negative values will supress warnings and errors;
  53 #   positive values will give more verbose output.
  54 verbosity: 0
  55
  56 # parse
  57 #   Whether or not parsing should be used to examine objects.
  58 parse: yes
  59
  60 # introspect
  61 #   Whether or not introspection should be used to examine objects.
  62 introspect: yes
  63
  64 # graph
  65 #   The list of graph types that should be automatically included
  66 #   in the output.  Graphs are generated using the Graphviz "dot"
  67 #   executable.  Graph types include: "classtree", "callgraph",
  68 #   "umlclass".  Use "all" to include all graph types
  69 #graph: umlclasstree
  70
  71 # dotpath
  72 #   The path to the Graphviz "dot" executable, used to generate
  73 #   graphs.
  74 dotpath: /usr/bin/dot
  75
  76 # sourcecode
  77 #   Whether or not to include syntax highlighted source code in
  78 #   the output (HTML only).
  79 sourcecode: yes
  80
  81 # pstat
  82 #   The name of one or more pstat files (generated by the profile
  83 #   or hotshot module).  These are used to generate call graphs.
  84 #pstat: profile.out
  85
  86 # separate-classes
  87 #   Whether each class should be listed in its own section when
  88 #   generating LaTeX or PDF output.
  89 separate-classes: no