bootstraparse/apidoc/moduleIndex.html

166 lines
8.9 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Module Index</title>
<meta name="generator" content="pydoctor 22.5.1">
</meta>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
<link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="apidocs.css" />
<link rel="stylesheet" type="text/css" href="extra.css" />
</head>
<body>
<nav class="navbar navbar-default mainnavbar">
<div class="container-fluid">
<div class="navbar-header">
<div class="navlinks">
<span class="navbar-brand">
bootstraparse <a href="index.html">API Documentation</a>
</span>
<a href="moduleIndex.html">
Modules
</a>
<a href="classIndex.html">
Classes
</a>
<a href="nameIndex.html">
Names
</a>
<div id="search-box-container">
<div class="input-group">
<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />
<span class="input-group-btn">
<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
</span>
</div>
</div>
</div>
<div id="search-results-container" style="display: none;">
<div id="search-buttons">
<span class="label label-default" id="search-docstrings-button">
<label class="checkbox-inline">
<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
search in docstrings
</input>
</label>
</span>
</div>
<noscript>
<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
</noscript>
<div class="hint" id="search-help-box">
<p class="rst-last">
Search bar offers the following options:
<ul>
<li>
<strong>Term presence.</strong> The below example searches for documents that
must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
</li>
<li>
<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
</li>
<li>
<strong>Search in specific fields.</strong> The following search matches all objects
in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>
<p>
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
Last two fields are only applicable if "search in docstrings" is enabled.
</p>
</li>
<li>
<strong>Fuzzy matches.</strong> The following search matches all documents
that have a word within 1 edit distance of “foo”: <code>foo~1</code>
</li>
</ul>
</p>
</div>
<div id="search-status"> </div>
<div class="warning" id="search-warn-box" style="display: none;">
<p class="rst-last"><span id="search-warn"></span></p>
</div>
<table id="search-results">
<!-- Filled dynamically by JS -->
</table>
<div style="margin-top: 8px;">
<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
</div>
</div>
</div>
</div>
</nav>
<div class="container-fluid">
<div class="page-header">
<h1>Module Index</h1>
<div id="showPrivate">
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
</div>
</div>
<ul id="summaryTree"><li><code><a href="index.html" class="internal-link">bootstraparse</a></code> - <span class="undocumented">No package docstring; 1/1 module, 1/1 package documented</span><ul><li><code><a href="bootstraparse.modules.html" class="internal-link" title="bootstraparse.modules">modules</a></code> - The modules in this folder are used to parse the website.<ul><li><code><a href="bootstraparse.modules.config.html" class="internal-link" title="bootstraparse.modules.config">config</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="bootstraparse.modules.context_mngr.html" class="internal-link" title="bootstraparse.modules.context_mngr">context_mngr</a></code> - <span class="undocumented">No module docstring; 0/1 variable, 2/19 classes documented</span></li><li><code><a href="bootstraparse.modules.environment.html" class="internal-link" title="bootstraparse.modules.environment">environment</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="bootstraparse.modules.error_mngr.html" class="internal-link" title="bootstraparse.modules.error_mngr">error_mngr</a></code> - <span class="undocumented">No module docstring; 0/1 constant, 3/3 functions, 4/4 classes documented</span></li><li><code><a href="bootstraparse.modules.export.html" class="internal-link" title="bootstraparse.modules.export">export</a></code> - <span class="undocumented">No module docstring; 1/2 variable, 1/1 function, 2/2 classes documented</span></li><li><code><a href="bootstraparse.modules.parser.html" class="internal-link" title="bootstraparse.modules.parser">parser</a></code> - <span class="undocumented">No module docstring; 1/1 function documented</span></li><li><code><a href="bootstraparse.modules.pathresolver.html" class="internal-link" title="bootstraparse.modules.pathresolver">pathresolver</a></code> - <span class="undocumented">No module docstring; 0/1 variable, 2/2 classes documented</span></li><li><code><a href="bootstraparse.modules.preparser.html" class="internal-link" title="bootstraparse.modules.preparser">preparser</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="bootstraparse.modules.sitecrawler.html" class="internal-link" title="bootstraparse.modules.sitecrawler">sitecrawler</a></code> - <span class="undocumented">No module docstring; 1/1 class documented</span></li><li><code><a href="bootstraparse.modules.sitecreator.html" class="internal-link" title="bootstraparse.modules.sitecreator">sitecreator</a></code> - <span class="undocumented">No module docstring; 5/5 functions documented</span></li><li><code><a href="bootstraparse.modules.syntax.html" class="internal-link" title="bootstraparse.modules.syntax">syntax</a></code> - # Dedicated module for the syntax of all the parsing # All tokens inherit a SemanticType among SemanticType, ExplicitSemanticType and EmptySemanticType # All tokens have a label, and __eq__ and __ne__ methods...</li><li><code><a href="bootstraparse.modules.template_mngr.html" class="internal-link" title="bootstraparse.modules.template_mngr">template_mngr</a></code> - <span class="undocumented">Undocumented</span></li><li><code><a href="bootstraparse.modules.tools.html" class="internal-link" title="bootstraparse.modules.tools">tools</a></code> - ############################################################################### # List of tools for testing ############################################################################### # Usage: # from bootstraparse...</li></ul></li><li class="private"><code><a href="bootstraparse.__main__.html" class="internal-link" title="bootstraparse.__main__">__main__</a></code> - Main program, use this to start parsing</li></ul></li></ul>
</div>
<footer class="navbar navbar-default">
<div class="container">
<a href="index.html">API Documentation</a> for bootstraparse,
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
22.5.1 at 2022-06-15 22:32:36.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML
parsing not to introduce overhead and display HTML data asap -->
<script src="ajax.js" type="text/javascript"></script>
<script src="searchlib.js" type="text/javascript"></script>
<script src="search.js" type="text/javascript"></script>
</footer>
<script src="pydoctor.js" type="text/javascript"></script>
</body>
</html>