Deploying to gh-pages from @ idle-org/bootstraparse@22b19d4481 🚀

This commit is contained in:
Malphaet 2022-06-15 22:51:11 +00:00
parent 0186e333fc
commit c7f1beba9a
92 changed files with 242 additions and 131 deletions

View File

@ -139,7 +139,7 @@
<div class="type">Package</div>
<div class="kind">Package</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No package docstring; 1/1 module, 1/1 package documented</span></div>
<div class="summary">Bootstraparse is a tool to parse a folder and create a website from it. After installing it with pip, you can use it by running the following command:</div>
</li><li id="bootstraparse.__main__">
<div class="fullName">bootstraparse<wbr></wbr>.__main__</div>
@ -163,7 +163,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
<div class="summary">Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage:</div>
</li><li id="bootstraparse.modules.context_mngr">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.context<wbr></wbr>_mngr</div>
@ -171,7 +171,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 0/1 variable, 2/19 classes documented</span></div>
<div class="summary">Interprets where the parser is located and resolves errors You're probably here for the ContextManager class. Containers have class_name, debug_map and validate methods for debug,</div>
</li><li id="bootstraparse.modules.environment">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.environment</div>
@ -179,7 +179,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
<div class="summary">Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and</div>
</li><li id="bootstraparse.modules.error_mngr">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.error<wbr></wbr>_mngr</div>
@ -187,7 +187,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 0/1 constant, 3/3 functions, 4/4 classes documented</span></div>
<div class="summary">Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception.</div>
</li><li id="bootstraparse.modules.export">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.export</div>
@ -195,7 +195,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 1/2 variable, 1/1 function, 2/2 classes documented</span></div>
<div class="summary">Module for final generation of the translated website Usage:</div>
</li><li id="bootstraparse.modules.parser">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.parser</div>
@ -203,7 +203,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 1/1 function documented</span></div>
<div class="summary">Main parser, gets config files and parses them for the context manager. parse_line takes a io and outputs it all as a list of parsed elements Usage:</div>
</li><li id="bootstraparse.modules.pathresolver">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.pathresolver</div>
@ -211,7 +211,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 0/1 variable, 2/2 classes documented</span></div>
<div class="summary">Module for resolving relative path problems PathResolver takes a relative path in the module and outputs the absolute path, BoostraPath can deal with relative paths in the installation folder. Usage:</div>
</li><li id="bootstraparse.modules.preparser">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.preparser</div>
@ -219,7 +219,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
<div class="summary">Module for pre-parsing user files in preparation for the parser Usage:</div>
</li><li id="bootstraparse.modules.sitecrawler">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.sitecrawler</div>
@ -227,7 +227,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 1/1 class documented</span></div>
<div class="summary">Module for file and directories repartition Usage:</div>
</li><li id="bootstraparse.modules.sitecreator">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.sitecreator</div>
@ -235,7 +235,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">No module docstring; 5/5 functions documented</span></div>
<div class="summary">Module sequencing the successive actions necessary for website building Usage:</div>
</li><li id="bootstraparse.modules.syntax">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.syntax</div>
@ -251,7 +251,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">Undocumented</span></div>
<div class="summary">Module for interpreting default or custom templates.</div>
</li><li id="bootstraparse.modules.tools">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.tools</div>
@ -259,7 +259,7 @@
<div class="type">ZopeInterfaceModule</div>
<div class="kind">Module</div>
<div class="privacy">PUBLIC</div>
<div class="summary">############################################################################### # List of tools for testing ############################################################################### # Usage: # from bootstraparse...</div>
<div class="summary">Usage:</div>
</li><li id="bootstraparse.modules.pathresolver.PathResolver">
<div class="fullName">bootstraparse<wbr></wbr>.modules<wbr></wbr>.pathresolver<wbr></wbr>.<wbr></wbr>Path<wbr></wbr>Resolver</div>

View File

@ -318,7 +318,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -662,7 +662,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -376,7 +376,14 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.config import ConfigLoader</li>
<li>config = ConfigLoader([list of config files], extensions=[list of extensions])</li>
<li>config['file']['key']</li>
</ul>
<p>The ConfigLoader class has load_from_file and load_from_folder methods and __getitem__ for accessing loaded elements</p>
</div>
</div>
<div id="splitTables">
@ -408,7 +415,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1450,7 +1450,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1135,7 +1135,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -984,7 +984,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -964,7 +964,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -941,7 +941,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -985,7 +985,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -941,7 +941,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -941,7 +941,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -985,7 +985,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -941,7 +941,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1004,7 +1004,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -984,7 +984,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -921,7 +921,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -959,7 +959,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -964,7 +964,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -964,7 +964,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -964,7 +964,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -894,7 +894,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -921,7 +921,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -569,7 +569,21 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Interprets where the parser is located and resolves errors You're probably here for the ContextManager class. Containers have class_name, debug_map and validate methods for debug,</p>
<ul class="rst-simple">
<li>self.content: accessible via __getitem__, __setitem__, add, __len__, __iter__ and __getslice__.</li>
<li>self.optionals: accessible via __rshift__ (remapped to return self.map[other]())</li>
<li>and self.map: accessible via __invert__ (remapped to return self.optionals)</li>
</ul>
<p>Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.context_mngr import ContextManager</li>
<li>ctx = ContextManager()</li>
<li>container = BaseContainer()</li>
<li>container[number] -&gt; The number element in the content</li>
<li>"class_insert" &gt;&gt; container[number] -&gt; Get an element from one of the mapped methods</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -716,7 +730,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -522,7 +522,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -376,7 +376,26 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and</p>
<ul class="rst-simple">
<li>self.wasInitialised and integrity_check for debug.</li>
<li>__getattr__ and __setattr__ check for existing super, s or m parameters, returns error if not found.</li>
</ul>
<p>Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.environment import Environment</li>
<li>env = Environment()</li>
<li>env.integrity_check() -&gt; Checks if all mandatory parameters are set.</li>
<li>env["config"] -&gt; returns config object</li>
<li>env["template"] -&gt; returns template object</li>
<li>env["export_mngr"] -&gt; returns export manager object</li>
<li>env["global_path"] -&gt; returns global path ???</li>
<li>env["user_path"] -&gt; returns user path ???</li>
<li>env["site_path"] -&gt; returns site path</li>
<li>env["export"] -&gt; returns export object ???</li>
<li>env["site_crawler"] -&gt; returns site crawler object</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -408,7 +427,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -343,7 +343,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -528,7 +528,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -528,7 +528,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -563,7 +563,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -452,7 +452,18 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception.</p>
<ul class="rst-simple">
<li>They take: message, level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL")</li>
</ul>
<p>There's also a dict_check(dic, *args) that returns true if all args are keys in the dict. Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.error_mngr import log_message, log_exception</li>
<li>log_message("This is a message", level="INFO") level=("ERROR, "INFO", "WARNING", "DEBUG", "CRITICAL")</li>
<li>log_exception(Exception("This is an exception"), level="ERROR")</li>
<li>dict_check({"a": 1, "b": 2}, "a", "b") # returns [True, True]</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -599,7 +610,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -741,7 +741,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -779,7 +779,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -422,7 +422,15 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Module for final generation of the translated website Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.export import ExportManager, ExportRequest, ExportResponse</li>
<li>rqs = ExportRequest("strucural_elements", "div", "optionals", {"id": "my_id", "class": "my_class"})</li>
<li>rsp = ExportResponse("start_string", "end_string")</li>
<li>em = ExportManager(config_file, template_file)</li>
<li>em(ExportRequest()) -&gt; ExportResponse()</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -535,7 +543,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -398,52 +398,52 @@
<td>Module</td>
<td><code><a href="bootstraparse.modules.config.html" class="internal-link" title="bootstraparse.modules.config">config</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage:</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.context_mngr.html" class="internal-link" title="bootstraparse.modules.context_mngr">context<wbr></wbr>_mngr</a></code></td>
<td><span class="undocumented">No module docstring; 0/1 variable, 2/19 classes documented</span></td>
<td>Interprets where the parser is located and resolves errors You're probably here for the ContextManager class. Containers have class_name, debug_map and validate methods for debug,</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.environment.html" class="internal-link" title="bootstraparse.modules.environment">environment</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.error_mngr.html" class="internal-link" title="bootstraparse.modules.error_mngr">error<wbr></wbr>_mngr</a></code></td>
<td><span class="undocumented">No module docstring; 0/1 constant, 3/3 functions, 4/4 classes documented</span></td>
<td>Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception.</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.export.html" class="internal-link" title="bootstraparse.modules.export">export</a></code></td>
<td><span class="undocumented">No module docstring; 1/2 variable, 1/1 function, 2/2 classes documented</span></td>
<td>Module for final generation of the translated website Usage:</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.parser.html" class="internal-link" title="bootstraparse.modules.parser">parser</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 function documented</span></td>
<td>Main parser, gets config files and parses them for the context manager. parse_line takes a io and outputs it all as a list of parsed elements Usage:</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.pathresolver.html" class="internal-link" title="bootstraparse.modules.pathresolver">pathresolver</a></code></td>
<td><span class="undocumented">No module docstring; 0/1 variable, 2/2 classes documented</span></td>
<td>Module for resolving relative path problems PathResolver takes a relative path in the module and outputs the absolute path, BoostraPath can deal with relative paths in the installation folder. Usage:</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.preparser.html" class="internal-link" title="bootstraparse.modules.preparser">preparser</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>Module for pre-parsing user files in preparation for the parser Usage:</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.sitecrawler.html" class="internal-link" title="bootstraparse.modules.sitecrawler">sitecrawler</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>Module for file and directories repartition Usage:</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.sitecreator.html" class="internal-link" title="bootstraparse.modules.sitecreator">sitecreator</a></code></td>
<td><span class="undocumented">No module docstring; 5/5 functions documented</span></td>
<td>Module sequencing the successive actions necessary for website building Usage:</td>
</tr><tr class="module">
<td>Module</td>
@ -453,12 +453,12 @@
<td>Module</td>
<td><code><a href="bootstraparse.modules.template_mngr.html" class="internal-link" title="bootstraparse.modules.template_mngr">template<wbr></wbr>_mngr</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
<td>Module for interpreting default or custom templates.</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="bootstraparse.modules.tools.html" class="internal-link" title="bootstraparse.modules.tools">tools</a></code></td>
<td>############################################################################### # List of tools for testing ############################################################################### # Usage: # from bootstraparse...</td>
<td>Usage:</td>
</tr>
</table>
@ -479,7 +479,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -376,7 +376,12 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Main parser, gets config files and parses them for the context manager. parse_line takes a io and outputs it all as a list of parsed elements Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.parser import parse_line</li>
<li>parse_line(io) -&gt; [element, element, element]</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -428,7 +433,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -392,7 +392,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -440,7 +440,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -399,7 +399,13 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Module for resolving relative path problems PathResolver takes a relative path in the module and outputs the absolute path, BoostraPath can deal with relative paths in the installation folder. Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.pathresolver import PathResolver, b_path</li>
<li>b_path("../relative/path/to/file") # returns absolute path to file from the bootstraparse folder</li>
<li>path= PathResolver("../relative/path/to/file") # Make a PathResolver object pointing at the first path given</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -461,7 +467,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1537,7 +1537,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -376,7 +376,16 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Module for pre-parsing user files in preparation for the parser Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.preparser import preparser</li>
<li>pp = preparser(file, enviroment)</li>
<li>pp.do_import() # imports all the modules and adds them to the file, do the same for all the files that are to be imported - # noqa</li>
<li>pp.do_replacements() # replaces all images and shortcuts in the file</li>
<li>pp.readlines() # returns the lines of ORIGINAL file</li>
<li>pp.get_all_lines() # returns the lines of the file after replacements and imports</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -408,7 +417,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -942,7 +942,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -376,7 +376,16 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Module for file and directories repartition Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules import SiteCrawler</li>
<li>crawler = SiteCrawler(origin_path, dest_path, _env)</li>
<li>crawler.set_all_preparsers()</li>
<li>crawler.copy_unparsable_files()</li>
<li>for element, destination in crawler:</li>
<li>- save(preparse_parse(element), destination, _env)</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -408,7 +417,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -416,7 +416,11 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Module sequencing the successive actions necessary for website building Usage:</p>
<ul class="rst-simple">
<li>create_website(origin, destination)</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -568,7 +572,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1413,7 +1413,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1348,7 +1348,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1587,7 +1587,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1384,7 +1384,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1384,7 +1384,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1816,7 +1816,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1588,7 +1588,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1384,7 +1384,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1588,7 +1588,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1588,7 +1588,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1386,7 +1386,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1588,7 +1588,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1415,7 +1415,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1395,7 +1395,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1384,7 +1384,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1383,7 +1383,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1446,7 +1446,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1375,7 +1375,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1619,7 +1619,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1611,7 +1611,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1816,7 +1816,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1415,7 +1415,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1348,7 +1348,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -1374,7 +1374,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -2650,7 +2650,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -363,7 +363,8 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Module for interpreting default or custom templates.</p>
</div>
</div>
<div id="splitTables">
@ -386,7 +387,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -146,6 +146,10 @@
</div>
<div>
<div class="childrenKindTitle">Contents</div>
<ul><li><a class="rst-reference internal" href="#rst-list-of-tools-for-testing" id="rst-toc-entry-1">List of tools for testing</a></li>
</ul>
@ -496,7 +500,16 @@
</div>
<div class="moduleDocstring">
<div><p>############################################################################### # List of tools for testing ############################################################################### # Usage: # from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file # __GLk(n) # Returns a file link n traceback objects back # __GL() # Returns a line number at current position # find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number</p>
<div><div class="rst-section" id="rst-list-of-tools-for-testing">
<h2 class="heading">List of tools for testing</h2>
<p>Usage:</p>
<ul class="rst-simple">
<li>from bootstraparse.modules.tools import __GLk, __GL, find_*_in_file</li>
<li>__GLk(n) # Returns a file link n traceback objects back</li>
<li>__GL() # Returns a line number at current position</li>
<li>find_*_in_file(file) # Try to find (class, function or variable) in file and return its line number</li>
</ul>
</div>
</div>
</div>
@ -845,7 +858,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -150,7 +150,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

File diff suppressed because one or more lines are too long

View File

@ -224,7 +224,11 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Bootstraparse is a tool to parse a folder and create a website from it. After installing it with pip, you can use it by running the following command:</p>
<ul class="rst-simple">
<li>bootstraparse &lt;origin&gt; &lt;destination&gt;</li>
</ul>
</div>
</div>
<div id="splitTables">
@ -261,7 +265,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -139,7 +139,7 @@
</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>
<ul id="summaryTree"><li><code><a href="index.html" class="internal-link">bootstraparse</a></code> - Bootstraparse is a tool to parse a folder and create a website from it. After installing it with pip, you can use it by running the following command:<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> - Interprets config files The Config will be loaded by the environment at runtime and should be accessed that way Usage:</li><li><code><a href="bootstraparse.modules.context_mngr.html" class="internal-link" title="bootstraparse.modules.context_mngr">context_mngr</a></code> - Interprets where the parser is located and resolves errors You're probably here for the ContextManager class. Containers have class_name, debug_map and validate methods for debug,</li><li><code><a href="bootstraparse.modules.environment.html" class="internal-link" title="bootstraparse.modules.environment">environment</a></code> - Module for containing super important variables Environment has self._mParams for mandatory parameters, self._sParams for secondary parameters and</li><li><code><a href="bootstraparse.modules.error_mngr.html" class="internal-link" title="bootstraparse.modules.error_mngr">error_mngr</a></code> - Dedicated module for defining and interpreting errors as well as generating error messages You're probably here for log_message or log_exception.</li><li><code><a href="bootstraparse.modules.export.html" class="internal-link" title="bootstraparse.modules.export">export</a></code> - Module for final generation of the translated website Usage:</li><li><code><a href="bootstraparse.modules.parser.html" class="internal-link" title="bootstraparse.modules.parser">parser</a></code> - Main parser, gets config files and parses them for the context manager. parse_line takes a io and outputs it all as a list of parsed elements Usage:</li><li><code><a href="bootstraparse.modules.pathresolver.html" class="internal-link" title="bootstraparse.modules.pathresolver">pathresolver</a></code> - Module for resolving relative path problems PathResolver takes a relative path in the module and outputs the absolute path, BoostraPath can deal with relative paths in the installation folder. Usage:</li><li><code><a href="bootstraparse.modules.preparser.html" class="internal-link" title="bootstraparse.modules.preparser">preparser</a></code> - Module for pre-parsing user files in preparation for the parser Usage:</li><li><code><a href="bootstraparse.modules.sitecrawler.html" class="internal-link" title="bootstraparse.modules.sitecrawler">sitecrawler</a></code> - Module for file and directories repartition Usage:</li><li><code><a href="bootstraparse.modules.sitecreator.html" class="internal-link" title="bootstraparse.modules.sitecreator">sitecreator</a></code> - Module sequencing the successive actions necessary for website building Usage:</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> - Module for interpreting default or custom templates.</li><li><code><a href="bootstraparse.modules.tools.html" class="internal-link" title="bootstraparse.modules.tools">tools</a></code> - Usage:</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>
@ -149,7 +149,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

View File

@ -338,7 +338,7 @@
<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.
22.5.1 at 2022-06-15 22:51:02.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML

File diff suppressed because one or more lines are too long

View File

@ -7,10 +7,11 @@ content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor" crossorigin="anonymous">
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js" integrity="sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2" crossorigin="anonymous"></script>
<title>bootstrap</title>
<title>Bootstraparse</title>
</head>
<body><br />
<br />
<br />
Structural Elements:
<div class='blue', 123 class="cinsertion">
This is a div