<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> <title>Epydoc: Sample Configuration File</title> <link rel="stylesheet" href="epydoc.css" type="text/css"/> </head> <!-- $Id: using.html 574 2003-07-21 06:51:56Z edloper $ --> <body> <div class="body"> <h1>Sample Configuration File</h1> <p>Configuration files, specified using the <code>--config</code> option, may be used to specify both the list of objects to document, and the options that should be used to document them. Configuration files are read using the standard <a href="http://docs.python.org/lib/module-ConfigParser.html">ConfigParser</a> module. The following example configuration file demonstrates the various options that you can set. Lines beginning with "#" or ";" are treated as comments. </p> <div class="screen"><pre> <b>[epydoc]</b> <i># Epydoc section marker (required by ConfigParser)</i> <i># <u>modules</u></i> <i># The list of objects to document. Objects can be named using</i> <i># dotted names, module filenames, or package directory names.</i> <i># Alases for this option include "objects" and "values".</i> <b>modules: sys, os.path, re</b> <i># <u>output</u></i> <i># The type of output that should be generated. Should be one</i> <i># of: html, text, latex, dvi, ps, pdf.</i> <b>output: html</b> <i># <u>target</u></i> <i># The path to the output directory. May be relative or absolute.</i> <b>target: html/</b> <i># <u>docformat</u></i> <i># The default markup language for docstrings, for modules that do</i> <i># not define __docformat__. Defaults to epytext.</i> <b>docformat: epytext</b> <i># <u>css</u></i> <i># The CSS stylesheet for HTML output. Can be the name of a builtin</i> <i># stylesheet, or the name of a file.</i> <b>css: white</b> <i># <u>name</u></i> <i># The documented project's name.</i> <b>name: Example</b> <i># <u>url</u></i> <i># The documented project's URL.</i> <b>url: http://some.project/</b> <i># <u>link</u></i> <i># HTML code for the project link in the navigation bar. If left</i> <i># unspecified, the project link will be generated based on the</i> <i># project's name and URL.</i> <b>link: <a href="somewhere">My Cool Project</a></b> <i># <u>top</u></i> <i># The "top" page for the documentation. Can be a URL, the name</i> <i># of a module or class, or one of the special names "trees.html",</i> <i># "indices.html", or "help.html"</i> <b>top: os.path</b> <i># <u>help</u></i> <i># An alternative help file. The named file should contain the</i> <i># body of an HTML file; navigation bars will be added to it.</i> <b>help: my_helpfile.html</b> <i># <u>frames</u></i> <i># Whether or not to include a frames-based table of contents.</i> <b>frames: yes</b> <i># <u>private</u></i> <i># Whether or not to inclue private variables. (Even if included,</i> <i># private variables will be hidden by default.)</i> <b>private: yes</b> <i># <u>imports</u></i> <i># Whether or not to list each module's imports.</i> <b>imports: no</b> <i># <u>verbosity</u></i> <i># An integer indicating how verbose epydoc should be. The default</i> <i># value is 0; negative values will supress warnings and errors;</i> <i># positive values will give more verbose output.</i> <b>verbosity: 0</b> <i># <u>parse</u></i> <i># Whether or not parsing should be used to examine objects.</i> <b>parse: yes</b> <i># <u>introspect</u></i> <i># Whether or not introspection should be used to examine objects.</i> <b>introspect: yes</b> <i># <u>graph</u></i> <i># The list of graph types that should be automatically included</i> <i># in the output. Graphs are generated using the Graphviz "dot"</i> <i># executable. Graph types include: "classtree", "callgraph",</i> <i># "umlclass". Use "all" to include all graph types</i> <b>graph: all</b> <i># <u>dotpath</u></i> <i># The path to the Graphviz "dot" executable, used to generate</i> <i># graphs.</i> <b>dotpath: /usr/local/bin/dot</b> <i># <u>sourcecode</u></i> <i># Whether or not to include syntax highlighted source code in</i> <i># the output (HTML only).</i> <b>sourcecode: yes</b> <i># <u>pstat</u></i> <i># The name of one or more pstat files (generated by the profile</i> <i># or hotshot module). These are used to generate call graphs.</i> <b>pstat: profile.out</b> <i># <u>separate-classes</u></i> <i># Whether each class should be listed in its own section when</i> <i># generating LaTeX or PDF output.</i> <b>separate-classes: no</b> </pre></div> </div> <table width="100%" class="navbox" cellpadding="1" cellspacing="0"> <tr> <a class="nav" href="index.html"> <td align="center" width="20%" class="nav"> <a class="nav" href="index.html"> Home</a></td></a> <a class="nav" href="installing.html"> <td align="center" width="20%" class="nav"> <a class="nav" href="installing.html"> Installing Epydoc</a></td></a> <a class="nav" href="using.html"> <td align="center" width="20%" class="nav"> <a class="nav" href="using.html"> Using Epydoc</a></td></a> <a class="nav" href="epytext.html"> <td align="center" width="20%" class="nav"> <a class="nav" href="epytext.html"> Epytext</a></td></a> <td align="center" width="20%" class="nav"> <A href="http://sourceforge.net/projects/epydoc"> <IMG src="sflogo.png" width="88" height="26" border="0" alt="SourceForge" align="top"/></A></td> </tr> </table> </body> </html>