This commit is contained in:
@@ -464,6 +464,15 @@
|
||||
<nav class="md-nav" aria-label="module">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.module--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.module-classes" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1090,6 +1099,15 @@
|
||||
<nav class="md-nav" aria-label="module">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.module--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.module-classes" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1198,7 +1216,8 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Documentation model representing a Python module or package.</p>
|
||||
<h3 id="docforge.models.module--summary">Summary</h3>
|
||||
<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
|
||||
@@ -1275,8 +1294,7 @@ introspection.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Mapping of object names to their corresponding
|
||||
<code>DocObject</code> representations.</p>
|
||||
<p>Mapping of object names to their corresponding <code>DocObject</code> representations.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1375,8 +1393,7 @@ introspection.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Documentation object to register as a top-level
|
||||
member of the module.</p>
|
||||
<p>Documentation object to register as a top-level member of the module.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
@@ -1421,17 +1438,8 @@ member of the module.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<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>
|
||||
<p>Iterable[DocObject]:
|
||||
An iterable of <code>DocObject</code> instances representing the module's public members.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1491,13 +1499,13 @@ member of the module.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<td><code>DocObject</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.models.object.DocObject" href="../object/#docforge.models.object.DocObject">DocObject</a></code>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Reference in New Issue
Block a user