aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated doc forge docs
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-03-07 16:24:14 +05:30
parent 91baa41bee
commit 8701bf92ac
26 changed files with 7831 additions and 8208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1051
libs/doc-forge/site/models/index.html
View File

File diff suppressed because it is too large Load Diff

596
libs/doc-forge/site/models/module/index.html
View File

@@ -86,7 +86,9 @@
<header class="md-header" data-md-component="header">
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -151,12 +153,19 @@
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
@@ -182,136 +191,6 @@
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../loaders/" class="md-tabs__link">
Loaders
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../" class="md-tabs__link">
Models
</a>
</li>
<li class="md-tabs__item">
<a href="../../nav/" class="md-tabs__link">
Navigation
</a>
</li>
<li class="md-tabs__item">
<a href="../../renderers/" class="md-tabs__link">
Renderers
</a>
</li>
<li class="md-tabs__item">
<a href="../../cli/" class="md-tabs__link">
CLI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
@@ -325,10 +204,8 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -371,13 +248,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -386,8 +273,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../loaders/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -396,8 +284,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
@@ -407,27 +301,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../loaders/" class="md-nav__link">
<span class="md-ellipsis">
Loaders
</span>
</a>
</li>
@@ -468,6 +341,18 @@
@@ -475,7 +360,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -485,8 +369,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -495,8 +380,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
@@ -506,27 +397,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -595,6 +465,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.module-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.module.Module" class="md-nav__link">
<span class="md-ellipsis">
Module
@@ -605,6 +485,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.module.Module-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.module.Module.add_object" class="md-nav__link">
<span class="md-ellipsis">
add_object
@@ -639,6 +529,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -711,13 +611,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -726,8 +640,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../nav/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -736,8 +651,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
@@ -747,27 +668,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../nav/" class="md-nav__link">
<span class="md-ellipsis">
Nav
</span>
</a>
</li>
@@ -853,13 +753,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -868,8 +782,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../renderers/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -878,8 +793,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
@@ -889,27 +810,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../renderers/" class="md-nav__link">
<span class="md-ellipsis">
Renderers
</span>
</a>
</li>
@@ -995,13 +895,29 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -1010,8 +926,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../cli/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -1020,8 +937,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
@@ -1031,27 +954,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cli/" class="md-nav__link">
<span class="md-ellipsis">
Cli
</span>
</a>
</li>
@@ -1189,6 +1091,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.module-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.module.Module" class="md-nav__link">
<span class="md-ellipsis">
Module
@@ -1199,6 +1111,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.module.Module-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.module.Module.add_object" class="md-nav__link">
<span class="md-ellipsis">
add_object
@@ -1233,6 +1155,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1259,16 +1191,18 @@
<h2 id="docforge.models.module" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">docforge.models.module</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">docforge.models.module</span>
</h2>
<div class="doc doc-contents first">
<p>This module defines the Module class, which represents a Python module or package
in the doc-forge documentation models. It acts as a container for top-level
documented objects.</p>
<p>Documentation model representing a Python module or package.</p>
<p>This module defines the <code>Module</code> class used in the doc-forge documentation
model. A <code>Module</code> acts as a container for top-level documented objects
(classes, functions, variables, and other members) discovered during
introspection.</p>
@@ -1279,24 +1213,27 @@ documented objects.</p>
<h3 id="docforge.models.module-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="docforge.models.module.Module" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">Module</span>
<h4 id="docforge.models.module.Module" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Module</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">Module</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">docstring</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span>
</code></pre></div>
</h4>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">Module</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">docstring</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Represents a documented Python module or package.</p>
<p>Representation of a documented Python module or package.</p>
<p>A <code>Module</code> stores metadata about the module itself and maintains a
collection of top-level documentation objects discovered during
introspection.</p>
<p><span class="doc-section-title">Attributes:</span></p>
@@ -1327,7 +1264,7 @@ documented objects.</p>
</td>
<td>
<div class="doc-md-description">
<p>Module-level docstring content.</p>
<p>Module-level documentation string, if present.</p>
</div>
</td>
</tr>
@@ -1338,14 +1275,15 @@ documented objects.</p>
</td>
<td>
<div class="doc-md-description">
<p>Dictionary mapping object names to their DocObject representations.</p>
<p>Mapping of object names to their corresponding
<code>DocObject</code> representations.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p>Initialize a new Module.</p>
<p>Initialize a Module instance.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1366,7 +1304,7 @@ documented objects.</p>
</td>
<td>
<div class="doc-md-description">
<p>The dotted path of the module.</p>
<p>Dotted import path identifying the module.</p>
</div>
</td>
<td>
@@ -1380,7 +1318,7 @@ documented objects.</p>
</td>
<td>
<div class="doc-md-description">
<p>The module's docstring, if any.</p>
<p>Module-level documentation text, if available.</p>
</div>
</td>
<td>
@@ -1401,18 +1339,18 @@ documented objects.</p>
<h5 id="docforge.models.module.Module-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h4 id="docforge.models.module.Module.add_object" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">add_object</span>
<h6 id="docforge.models.module.Module.add_object" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">add_object</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">add_object</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">DocObject</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">add_object</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">DocObject</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
@@ -1437,7 +1375,8 @@ documented objects.</p>
</td>
<td>
<div class="doc-md-description">
<p>The object to add.</p>
<p>Documentation object to register as a top-level
member of the module.</p>
</div>
</td>
<td>
@@ -1454,17 +1393,17 @@ documented objects.</p>
<div class="doc doc-object doc-function">
<h4 id="docforge.models.module.Module.get_all_objects" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_all_objects</span>
<h6 id="docforge.models.module.Module.get_all_objects" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_all_objects</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_all_objects</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">DocObject</span><span class="p">]</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">get_all_objects</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">DocObject</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Get all top-level objects in the module.</p>
<p>Return all top-level documentation objects in the module.</p>
<p><span class="doc-section-title">Returns:</span></p>
@@ -1482,7 +1421,17 @@ documented objects.</p>
</td>
<td>
<div class="doc-md-description">
<p>An iterable of DocObject instances.</p>
<p>An iterable of <code>DocObject</code> instances representing the</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code><span title="typing.Iterable">Iterable</span>[<a class="autorefs autorefs-internal" title="docforge.models.object.DocObject" href="../object/#docforge.models.object.DocObject">DocObject</a>]</code>
</td>
<td>
<div class="doc-md-description">
<p>module's public members.</p>
</div>
</td>
</tr>
@@ -1496,17 +1445,17 @@ documented objects.</p>
<div class="doc doc-object doc-function">
<h4 id="docforge.models.module.Module.get_object" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_object</span>
<h6 id="docforge.models.module.Module.get_object" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_object</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_object</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DocObject</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">get_object</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DocObject</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Retrieve a member object by name.</p>
<p>Retrieve a documented object by name.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1527,7 +1476,7 @@ documented objects.</p>
</td>
<td>
<div class="doc-md-description">
<p>The name of the object.</p>
<p>Name of the object to retrieve.</p>
</div>
</td>
<td>
@@ -1553,7 +1502,30 @@ documented objects.</p>
</td>
<td>
<div class="doc-md-description">
<p>The requested DocObject.</p>
<p>The corresponding <code>DocObject</code> instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code>KeyError</code>
</td>
<td>
<div class="doc-md-description">
<p>If no object with the given name exists.</p>
</div>
</td>
</tr>
@@ -1597,6 +1569,8 @@ documented objects.</p>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
@@ -1634,7 +1608,7 @@ documented objects.</p>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>

601
libs/doc-forge/site/models/object/index.html
View File

@@ -86,7 +86,9 @@
<header class="md-header" data-md-component="header">
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -151,12 +153,19 @@
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
@@ -182,136 +191,6 @@
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../loaders/" class="md-tabs__link">
Loaders
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../" class="md-tabs__link">
Models
</a>
</li>
<li class="md-tabs__item">
<a href="../../nav/" class="md-tabs__link">
Navigation
</a>
</li>
<li class="md-tabs__item">
<a href="../../renderers/" class="md-tabs__link">
Renderers
</a>
</li>
<li class="md-tabs__item">
<a href="../../cli/" class="md-tabs__link">
CLI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
@@ -325,10 +204,8 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -371,13 +248,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -386,8 +273,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../loaders/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -396,8 +284,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
@@ -407,27 +301,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../loaders/" class="md-nav__link">
<span class="md-ellipsis">
Loaders
</span>
</a>
</li>
@@ -468,6 +341,18 @@
@@ -475,7 +360,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -485,8 +369,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -495,8 +380,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
@@ -506,27 +397,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -618,6 +488,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.object-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.object.DocObject" class="md-nav__link">
<span class="md-ellipsis">
DocObject
@@ -628,6 +508,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.object.DocObject-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.object.DocObject.add_member" class="md-nav__link">
<span class="md-ellipsis">
add_member
@@ -662,6 +552,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -711,13 +611,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -726,8 +640,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../nav/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -736,8 +651,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
@@ -747,27 +668,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../nav/" class="md-nav__link">
<span class="md-ellipsis">
Nav
</span>
</a>
</li>
@@ -853,13 +753,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -868,8 +782,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../renderers/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -878,8 +793,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
@@ -889,27 +810,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../renderers/" class="md-nav__link">
<span class="md-ellipsis">
Renderers
</span>
</a>
</li>
@@ -995,13 +895,29 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -1010,8 +926,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../cli/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -1020,8 +937,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
@@ -1031,27 +954,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cli/" class="md-nav__link">
<span class="md-ellipsis">
Cli
</span>
</a>
</li>
@@ -1189,6 +1091,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.object-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.object.DocObject" class="md-nav__link">
<span class="md-ellipsis">
DocObject
@@ -1199,6 +1111,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.object.DocObject-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.object.DocObject.add_member" class="md-nav__link">
<span class="md-ellipsis">
add_member
@@ -1233,6 +1155,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1259,16 +1191,18 @@
<h2 id="docforge.models.object" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">docforge.models.object</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">docforge.models.object</span>
</h2>
<div class="doc doc-contents first">
<p>This module defines the DocObject class, the fundamental recursive unit of the
doc-forge documentation models. A DocObject represents a single Python entity
(class, function, method, or attribute) and its nested members.</p>
<p>Documentation model representing individual Python objects.</p>
<p>This module defines the <code>DocObject</code> class, the fundamental recursive unit of
the doc-forge documentation model. Each <code>DocObject</code> represents a Python
entity such as a class, function, method, or attribute, and may contain nested
members that form a hierarchical documentation structure.</p>
@@ -1279,24 +1213,27 @@ doc-forge documentation models. A DocObject represents a single Python entity
<h3 id="docforge.models.object-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="docforge.models.object.DocObject" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">DocObject</span>
<h4 id="docforge.models.object.DocObject" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">DocObject</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">DocObject</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">kind</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">signature</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">docstring</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span>
</code></pre></div>
</h4>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">DocObject</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">kind</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">signature</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">docstring</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Represents a documented Python object (class, function, method, etc.).</p>
<p>Representation of a documented Python object.</p>
<p>A <code>DocObject</code> models a single Python entity discovered during
introspection. Objects may contain nested members, allowing the structure
of modules, classes, and other containers to be represented recursively.</p>
<p><span class="doc-section-title">Attributes:</span></p>
@@ -1327,7 +1264,8 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>Type of object (e.g., 'class', 'function', 'attribute').</p>
<p>Type of object (for example <code>class</code>, <code>function</code>,
<code>method</code>, or <code>attribute</code>).</p>
</div>
</td>
</tr>
@@ -1338,7 +1276,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>Full dotted import path to the object.</p>
<p>Fully qualified dotted path to the object.</p>
</div>
</td>
</tr>
@@ -1349,7 +1287,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>Callable signature, if applicable.</p>
<p>Callable signature if the object represents a callable.</p>
</div>
</td>
</tr>
@@ -1360,7 +1298,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>Raw docstring content extracted from the source.</p>
<p>Raw docstring text extracted from the source code.</p>
</div>
</td>
</tr>
@@ -1371,14 +1309,14 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>Dictionary mapping member names to their DocObject representations.</p>
<p>Mapping of member names to child <code>DocObject</code> instances.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p>Initialize a new DocObject.</p>
<p>Initialize a DocObject instance.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1399,7 +1337,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>The local name of the object.</p>
<p>Local name of the object.</p>
</div>
</td>
<td>
@@ -1413,7 +1351,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>The kind of object (e.g., 'class', 'function').</p>
<p>Object type identifier (for example <code>class</code> or <code>function</code>).</p>
</div>
</td>
<td>
@@ -1427,7 +1365,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>The full dotted path to the object.</p>
<p>Fully qualified dotted path of the object.</p>
</div>
</td>
<td>
@@ -1441,7 +1379,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>The object's signature (for callable objects).</p>
<p>Callable signature if applicable.</p>
</div>
</td>
<td>
@@ -1455,7 +1393,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>The object's docstring, if any.</p>
<p>Documentation string associated with the object.</p>
</div>
</td>
<td>
@@ -1476,22 +1414,24 @@ doc-forge documentation models. A DocObject represents a single Python entity
<h5 id="docforge.models.object.DocObject-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h4 id="docforge.models.object.DocObject.add_member" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">add_member</span>
<h6 id="docforge.models.object.DocObject.add_member" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">add_member</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">add_member</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">DocObject</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">add_member</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">DocObject</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Add a child member to this object (e.g., a method to a class).</p>
<p>Add a child documentation object.</p>
<p>This is typically used when attaching methods to classes or
nested objects to their parent containers.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1512,7 +1452,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>The child DocObject to add.</p>
<p>Documentation object to add as a member.</p>
</div>
</td>
<td>
@@ -1529,17 +1469,17 @@ doc-forge documentation models. A DocObject represents a single Python entity
<div class="doc doc-object doc-function">
<h4 id="docforge.models.object.DocObject.get_all_members" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_all_members</span>
<h6 id="docforge.models.object.DocObject.get_all_members" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_all_members</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_all_members</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">DocObject</span><span class="p">]</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">get_all_members</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">DocObject</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Get all members of this object.</p>
<p>Return all child members of the object.</p>
<p><span class="doc-section-title">Returns:</span></p>
@@ -1557,7 +1497,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>An iterable of child DocObject instances.</p>
<p>An iterable of <code>DocObject</code> instances representing nested members.</p>
</div>
</td>
</tr>
@@ -1571,17 +1511,17 @@ doc-forge documentation models. A DocObject represents a single Python entity
<div class="doc doc-object doc-function">
<h4 id="docforge.models.object.DocObject.get_member" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_member</span>
<h6 id="docforge.models.object.DocObject.get_member" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_member</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_member</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DocObject</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">get_member</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DocObject</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Retrieve a child member by name.</p>
<p>Retrieve a member object by name.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1602,7 +1542,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>The name of the member.</p>
<p>Name of the member to retrieve.</p>
</div>
</td>
<td>
@@ -1628,7 +1568,30 @@ doc-forge documentation models. A DocObject represents a single Python entity
</td>
<td>
<div class="doc-md-description">
<p>The requested DocObject.</p>
<p>The corresponding <code>DocObject</code> instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code>KeyError</code>
</td>
<td>
<div class="doc-md-description">
<p>If the member does not exist.</p>
</div>
</td>
</tr>
@@ -1672,6 +1635,8 @@ doc-forge documentation models. A DocObject represents a single Python entity
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
@@ -1709,7 +1674,7 @@ doc-forge documentation models. A DocObject represents a single Python entity
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>

591
libs/doc-forge/site/models/project/index.html
View File

@@ -86,7 +86,9 @@
<header class="md-header" data-md-component="header">
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -151,12 +153,19 @@
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
@@ -182,136 +191,6 @@
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../loaders/" class="md-tabs__link">
Loaders
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../" class="md-tabs__link">
Models
</a>
</li>
<li class="md-tabs__item">
<a href="../../nav/" class="md-tabs__link">
Navigation
</a>
</li>
<li class="md-tabs__item">
<a href="../../renderers/" class="md-tabs__link">
Renderers
</a>
</li>
<li class="md-tabs__item">
<a href="../../cli/" class="md-tabs__link">
CLI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
@@ -325,10 +204,8 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -371,13 +248,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -386,8 +273,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../loaders/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -396,8 +284,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
@@ -407,27 +301,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../loaders/" class="md-nav__link">
<span class="md-ellipsis">
Loaders
</span>
</a>
</li>
@@ -468,6 +341,18 @@
@@ -475,7 +360,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -485,8 +369,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -495,8 +380,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
@@ -506,27 +397,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -641,6 +511,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.project-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.project.Project" class="md-nav__link">
<span class="md-ellipsis">
Project
@@ -651,6 +531,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.project.Project-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.project.Project.add_module" class="md-nav__link">
<span class="md-ellipsis">
add_module
@@ -694,6 +584,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -720,13 +620,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -735,8 +649,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../nav/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -745,8 +660,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
@@ -756,27 +677,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../nav/" class="md-nav__link">
<span class="md-ellipsis">
Nav
</span>
</a>
</li>
@@ -862,13 +762,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -877,8 +791,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../renderers/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -887,8 +802,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
@@ -898,27 +819,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../renderers/" class="md-nav__link">
<span class="md-ellipsis">
Renderers
</span>
</a>
</li>
@@ -1004,13 +904,29 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -1019,8 +935,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../cli/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -1029,8 +946,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
@@ -1040,27 +963,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cli/" class="md-nav__link">
<span class="md-ellipsis">
Cli
</span>
</a>
</li>
@@ -1198,6 +1100,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.project-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.project.Project" class="md-nav__link">
<span class="md-ellipsis">
Project
@@ -1208,6 +1120,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.project.Project-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.models.project.Project.add_module" class="md-nav__link">
<span class="md-ellipsis">
add_module
@@ -1251,6 +1173,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1277,15 +1209,17 @@
<h2 id="docforge.models.project" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">docforge.models.project</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">docforge.models.project</span>
</h2>
<div class="doc doc-contents first">
<p>This module defines the Project class, the top-level container for a documented
project. It aggregates multiple Module instances into a single named entity.</p>
<p>Documentation model representing a project.</p>
<p>This module defines the <code>Project</code> class, the top-level container used by
doc-forge to represent a documented codebase. A <code>Project</code> aggregates multiple
modules and provides access to them through a unified interface.</p>
@@ -1296,24 +1230,26 @@ project. It aggregates multiple Module instances into a single named entity.</p>
<h3 id="docforge.models.project-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="docforge.models.project.Project" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">Project</span>
<h4 id="docforge.models.project.Project" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">Project</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">Project</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span>
</code></pre></div>
</h4>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">Project</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Represents a documentation project, serving as a container for modules.</p>
<p>Representation of a documentation project.</p>
<p>A <code>Project</code> serves as the root container for all modules discovered during
introspection. Each module is stored by its dotted import path.</p>
<p><span class="doc-section-title">Attributes:</span></p>
@@ -1344,14 +1280,14 @@ project. It aggregates multiple Module instances into a single named entity.</p>
</td>
<td>
<div class="doc-md-description">
<p>Dictionary mapping module paths to Module instances.</p>
<p>Mapping of module paths to <code>Module</code> instances.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p>Initialize a new Project.</p>
<p>Initialize a Project instance.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1372,7 +1308,7 @@ project. It aggregates multiple Module instances into a single named entity.</p>
</td>
<td>
<div class="doc-md-description">
<p>The name of the project.</p>
<p>Name used to identify the documentation project.</p>
</div>
</td>
<td>
@@ -1393,22 +1329,22 @@ project. It aggregates multiple Module instances into a single named entity.</p>
<h5 id="docforge.models.project.Project-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h4 id="docforge.models.project.Project.add_module" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">add_module</span>
<h6 id="docforge.models.project.Project.add_module" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">add_module</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">add_module</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="n">Module</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">add_module</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="n">Module</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Add a module to the project.</p>
<p>Register a module in the project.</p>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1429,7 +1365,7 @@ project. It aggregates multiple Module instances into a single named entity.</p>
</td>
<td>
<div class="doc-md-description">
<p>The module to add.</p>
<p>Module instance to add to the project.</p>
</div>
</td>
<td>
@@ -1446,17 +1382,17 @@ project. It aggregates multiple Module instances into a single named entity.</p>
<div class="doc doc-object doc-function">
<h4 id="docforge.models.project.Project.get_all_modules" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_all_modules</span>
<h6 id="docforge.models.project.Project.get_all_modules" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_all_modules</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_all_modules</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Module</span><span class="p">]</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">get_all_modules</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Module</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Get all modules in the project.</p>
<p>Return all modules contained in the project.</p>
<p><span class="doc-section-title">Returns:</span></p>
@@ -1474,7 +1410,7 @@ project. It aggregates multiple Module instances into a single named entity.</p>
</td>
<td>
<div class="doc-md-description">
<p>An iterable of Module objects.</p>
<p>An iterable of <code>Module</code> instances.</p>
</div>
</td>
</tr>
@@ -1488,13 +1424,13 @@ project. It aggregates multiple Module instances into a single named entity.</p>
<div class="doc doc-object doc-function">
<h4 id="docforge.models.project.Project.get_module" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_module</span>
<h6 id="docforge.models.project.Project.get_module" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_module</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_module</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Module</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">get_module</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Module</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
@@ -1519,7 +1455,7 @@ project. It aggregates multiple Module instances into a single named entity.</p>
</td>
<td>
<div class="doc-md-description">
<p>The dotted path of the module (e.g., 'pkg.mod').</p>
<p>Fully qualified dotted module path (for example <code>pkg.module</code>).</p>
</div>
</td>
<td>
@@ -1545,7 +1481,30 @@ project. It aggregates multiple Module instances into a single named entity.</p>
</td>
<td>
<div class="doc-md-description">
<p>The requested Module.</p>
<p>The corresponding <code>Module</code> instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code>KeyError</code>
</td>
<td>
<div class="doc-md-description">
<p>If the module does not exist in the project.</p>
</div>
</td>
</tr>
@@ -1559,17 +1518,17 @@ project. It aggregates multiple Module instances into a single named entity.</p>
<div class="doc doc-object doc-function">
<h4 id="docforge.models.project.Project.get_module_list" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">get_module_list</span>
<h6 id="docforge.models.project.Project.get_module_list" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_module_list</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_module_list</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">get_module_list</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Get the list of all module dotted paths.</p>
<p>Return the list of module import paths.</p>
<p><span class="doc-section-title">Returns:</span></p>
@@ -1587,7 +1546,7 @@ project. It aggregates multiple Module instances into a single named entity.</p>
</td>
<td>
<div class="doc-md-description">
<p>A list of module paths.</p>
<p>A list containing the dotted paths of all modules in the project.</p>
</div>
</td>
</tr>
@@ -1631,6 +1590,8 @@ project. It aggregates multiple Module instances into a single named entity.</p>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
@@ -1668,7 +1629,7 @@ project. It aggregates multiple Module instances into a single named entity.</p>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>