subtle/docs/epydoc.config

   1 [epydoc] # Epydoc section marker (required by ConfigParser)
   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: ../Subtle
   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: html/
  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: white
  27
  28 # name
  29 #   The documented project's name.
  30 name: Subtle
  31
  32 # url
  33 #   The documented project's URL.
  34 url: http://wiki.xiph.org/Subtle
  35
  36 # link
  37 #   HTML code for the project link in the navigation bar.  If left
  38 #   unspecified, the project link will be generated based on the
  39 #   project's name and URL.
  40 link: <a href="http://wiki.xiph.org/Subtle">Subtle</a>
  41
  42 # top
  43 #   The "top" page for the documentation.  Can be a URL, the name
  44 #   of a module or class, or one of the special names "trees.html",
  45 #   "indices.html", or "help.html"
  46 top: Subtle
  47
  48 # help
  49 #   An alternative help file.  The named file should contain the
  50 #   body of an HTML file; navigation bars will be added to it.
  51 #help: my_helpfile.html
  52
  53 # frames
  54 #   Whether or not to include a frames-based table of contents.
  55 frames: yes
  56
  57 # private
  58 #   Whether or not to inclue private variables.  (Even if included,
  59 #   private variables will be hidden by default.)
  60 private: yes
  61
  62 # imports
  63 #   Whether or not to list each module's imports.
  64 imports: yes
  65
  66 # verbosity
  67 #   An integer indicating how verbose epydoc should be.  The default
  68 #   value is 0; negative values will supress warnings and errors;
  69 #   positive values will give more verbose output.
  70 verbosity: 0
  71
  72 # parse
  73 #   Whether or not parsing should be used to examine objects.
  74 parse: yes
  75
  76 # introspect
  77 #   Whether or not introspection should be used to examine objects.
  78 introspect: yes
  79
  80 # graph
  81 #   The list of graph types that should be automatically included
  82 #   in the output.  Graphs are generated using the Graphviz "dot"
  83 #   executable.  Graph types include: "classtree", "callgraph",
  84 #   "umlclass".  Use "all" to include all graph types
  85 graph: all
  86
  87 # dotpath
  88 #   The path to the Graphviz "dot" executable, used to generate
  89 #   graphs.
  90 dotpath: /usr/bin/dot
  91
  92 # sourcecode
  93 #   Whether or not to include syntax highlighted source code in
  94 #   the output (HTML only).
  95 sourcecode: yes
  96
  97 # pstat
  98 #   The name of one or more pstat files (generated by the profile
  99 #   or hotshot module).  These are used to generate call graphs.
 100 #pstat: profile.out
 101
 102 # separate-classes
 103 #   Whether each class should be listed in its own section when
 104 #   generating LaTeX or PDF output.
 105 separate-classes: no
 106
 107