<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.docbuilder.BuildOptions</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.docbuilder-module.html">Module docbuilder</a> ::
Class BuildOptions
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.docbuilder.BuildOptions-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class BuildOptions</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.docbuilder-pysrc.html#BuildOptions">source code</a></span></p>
<p>Holds the parameters for a documentation building process.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">introspect</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">parse</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">exclude_introspect</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">exclude_parse</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">add_submodules</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docbuilder-pysrc.html#BuildOptions.__init__">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___12-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for___init___12-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for___init___12" name="call_graph_for___init___12">
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#__init__" title="__init__()" alt="" coords="215,6,311,38" />
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="build_doc_index()" alt="" coords="5,6,165,38" />
</map>
<img src="call_graph_for___init___12.gif" alt='' usemap="#call_graph_for___init___12" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docbuilder.BuildOptions-class.html#must_introspect" class="summary-sig-name">must_introspect</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Return <code>True</code> if a module is to be introsepcted with the
current settings.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docbuilder-pysrc.html#BuildOptions.must_introspect">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_must_introspect-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_must_introspect-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_must_introspect" name="call_graph_for_must_introspect">
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#_matches_filter" title="_matches_filter()" alt="" coords="513,6,663,38" />
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#must_introspect" title="must_introspect()" alt="" coords="311,6,463,38" />
<area shape="rect" href="epydoc.docbuilder-module.html#_get_docs_from_module_file" title="_get_docs_from_module_file()" alt="" coords="7,6,260,38" />
</map>
<img src="call_graph_for_must_introspect.gif" alt='' usemap="#call_graph_for_must_introspect" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docbuilder.BuildOptions-class.html#must_parse" class="summary-sig-name">must_parse</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Return <code>True</code> if a module is to be parsed with the current
settings.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docbuilder-pysrc.html#BuildOptions.must_parse">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_must_parse-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_must_parse-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_must_parse" name="call_graph_for_must_parse">
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#_matches_filter" title="_matches_filter()" alt="" coords="479,6,628,38" />
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#must_parse" title="must_parse()" alt="" coords="311,6,428,38" />
<area shape="rect" href="epydoc.docbuilder-module.html#_get_docs_from_module_file" title="_get_docs_from_module_file()" alt="" coords="7,6,260,38" />
</map>
<img src="call_graph_for_must_parse.gif" alt='' usemap="#call_graph_for_must_parse" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>bool</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docbuilder.BuildOptions-class.html#_matches_filter" class="summary-sig-name" onclick="show_private();">_matches_filter</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">regexp</span>)</span><br />
Test if a module name matches a pattern.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docbuilder-pysrc.html#BuildOptions._matches_filter">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__matches_filter-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__matches_filter-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__matches_filter" name="call_graph_for__matches_filter">
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#_matches_filter" title="_matches_filter()" alt="" coords="209,34,359,66" />
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#must_introspect" title="must_introspect()" alt="" coords="7,6,159,38" />
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#must_parse" title="must_parse()" alt="" coords="24,62,141,94" />
</map>
<img src="call_graph_for__matches_filter.gif" alt='' usemap="#call_graph_for__matches_filter" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="must_introspect"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">must_introspect</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docbuilder-pysrc.html#BuildOptions.must_introspect">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_must_introspect-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_must_introspect-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_must_introspect" name="call_graph_for_must_introspect">
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#_matches_filter" title="_matches_filter()" alt="" coords="513,6,663,38" />
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#must_introspect" title="must_introspect()" alt="" coords="311,6,463,38" />
<area shape="rect" href="epydoc.docbuilder-module.html#_get_docs_from_module_file" title="_get_docs_from_module_file()" alt="" coords="7,6,260,38" />
</map>
<img src="call_graph_for_must_introspect.gif" alt='' usemap="#call_graph_for_must_introspect" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return <code>True</code> if a module is to be introsepcted with the
current settings.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (<a href="epydoc.apidoc.DottedName-class.html"
class="link">DottedName</a> or <code>str</code>) - The name of the module to test</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="must_parse"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">must_parse</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docbuilder-pysrc.html#BuildOptions.must_parse">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_must_parse-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_must_parse-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_must_parse" name="call_graph_for_must_parse">
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#_matches_filter" title="_matches_filter()" alt="" coords="479,6,628,38" />
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#must_parse" title="must_parse()" alt="" coords="311,6,428,38" />
<area shape="rect" href="epydoc.docbuilder-module.html#_get_docs_from_module_file" title="_get_docs_from_module_file()" alt="" coords="7,6,260,38" />
</map>
<img src="call_graph_for_must_parse.gif" alt='' usemap="#call_graph_for_must_parse" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return <code>True</code> if a module is to be parsed with the current
settings.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (<a href="epydoc.apidoc.DottedName-class.html"
class="link">DottedName</a> or <code>str</code>) - The name of the module to test</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_matches_filter"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_matches_filter</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">regexp</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docbuilder-pysrc.html#BuildOptions._matches_filter">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__matches_filter-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__matches_filter-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__matches_filter" name="call_graph_for__matches_filter">
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#_matches_filter" title="_matches_filter()" alt="" coords="209,34,359,66" />
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#must_introspect" title="must_introspect()" alt="" coords="7,6,159,38" />
<area shape="rect" href="epydoc.docbuilder.BuildOptions-class.html#must_parse" title="must_parse()" alt="" coords="24,62,141,94" />
</map>
<img src="call_graph_for__matches_filter.gif" alt='' usemap="#call_graph_for__matches_filter" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Test if a module name matches a pattern.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (<a href="epydoc.apidoc.DottedName-class.html"
class="link">DottedName</a> or <code>str</code>) - The name of the module to test</li>
<li><strong class="pname"><code>regexp</code></strong> (<code>pattern</code>) - The pattern object to match <code>name</code> against. If
<code>None</code>, return <code>False</code></li>
</ul></dd>
<dt>Returns: <code>bool</code></dt>
<dd><code>True</code> if <code>name</code> in dotted format matches
<code>regexp</code>, else <code>False</code></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:07:37 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
