This commit is contained in:
@@ -961,6 +961,15 @@
|
||||
<nav class="md-nav" aria-label="models">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models--overview" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1201,11 +1210,12 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Model layer for doc-forge.</p>
|
||||
<h3 id="docforge.models--summary">Summary</h3>
|
||||
<p>Model layer for doc-forge.</p>
|
||||
<p>The <code>docforge.models</code> package defines the core data structures used to
|
||||
represent Python source code as a structured documentation model.</p>
|
||||
<hr />
|
||||
<h4 id="docforge.models--overview">Overview</h4>
|
||||
<h3 id="docforge.models--overview">Overview</h3>
|
||||
<p>The model layer forms the central intermediate representation used throughout
|
||||
doc-forge. Python modules and objects discovered during introspection are
|
||||
converted into a hierarchy of documentation models that can later be rendered
|
||||
@@ -1283,8 +1293,7 @@ of modules, classes, and other containers to be represented recursively.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Type of object (for example <code>class</code>, <code>function</code>,
|
||||
<code>method</code>, or <code>attribute</code>).</p>
|
||||
<p>Type of object (for example <code>class</code>, <code>function</code>, <code>method</code>, or <code>attribute</code>).</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1516,7 +1525,8 @@ nested objects to their parent containers.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>An iterable of <code>DocObject</code> instances representing nested members.</p>
|
||||
<p>Iterable[DocObject]:
|
||||
An iterable of <code>DocObject</code> instances representing nested members.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1576,13 +1586,13 @@ nested objects to their parent containers.</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>
|
||||
@@ -1689,8 +1699,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>
|
||||
@@ -1789,8 +1798,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>
|
||||
@@ -1835,17 +1843,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>
|
||||
@@ -1905,13 +1904,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>
|
||||
@@ -2136,7 +2135,8 @@ introspection. Each module is stored by its dotted import path.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>An iterable of <code>Module</code> instances.</p>
|
||||
<p>Iterable[Module]:
|
||||
An iterable of <code>Module</code> instances.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -2196,13 +2196,13 @@ introspection. Each module is stored by its dotted import path.</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>Module</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.models.module.Module" href="module/#docforge.models.module.Module">Module</a></code>
|
||||
</td>
|
||||
<td>
|
||||
@@ -2272,7 +2272,8 @@ introspection. Each module is stored by its dotted import path.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A list containing the dotted paths of all modules in the project.</p>
|
||||
<p>list[str]:
|
||||
A list containing the dotted paths of all modules in the project.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -487,6 +487,15 @@
|
||||
<nav class="md-nav" aria-label="object">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.object--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.object-classes" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1090,6 +1099,15 @@
|
||||
<nav class="md-nav" aria-label="object">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.object--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.object-classes" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1198,7 +1216,8 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Documentation model representing individual Python objects.</p>
|
||||
<h3 id="docforge.models.object--summary">Summary</h3>
|
||||
<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
|
||||
@@ -1264,8 +1283,7 @@ of modules, classes, and other containers to be represented recursively.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Type of object (for example <code>class</code>, <code>function</code>,
|
||||
<code>method</code>, or <code>attribute</code>).</p>
|
||||
<p>Type of object (for example <code>class</code>, <code>function</code>, <code>method</code>, or <code>attribute</code>).</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1497,7 +1515,8 @@ nested objects to their parent containers.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>An iterable of <code>DocObject</code> instances representing nested members.</p>
|
||||
<p>Iterable[DocObject]:
|
||||
An iterable of <code>DocObject</code> instances representing nested members.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1557,13 +1576,13 @@ nested objects to their parent containers.</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="#docforge.models.object.DocObject">DocObject</a></code>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
@@ -510,6 +510,15 @@
|
||||
<nav class="md-nav" aria-label="project">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.project--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.project-classes" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1099,6 +1108,15 @@
|
||||
<nav class="md-nav" aria-label="project">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.project--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.models.project-classes" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1216,7 +1234,8 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Documentation model representing a project.</p>
|
||||
<h3 id="docforge.models.project--summary">Summary</h3>
|
||||
<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>
|
||||
@@ -1410,7 +1429,8 @@ introspection. Each module is stored by its dotted import path.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>An iterable of <code>Module</code> instances.</p>
|
||||
<p>Iterable[Module]:
|
||||
An iterable of <code>Module</code> instances.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1470,13 +1490,13 @@ introspection. Each module is stored by its dotted import path.</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>Module</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.models.module.Module" href="../module/#docforge.models.module.Module">Module</a></code>
|
||||
</td>
|
||||
<td>
|
||||
@@ -1546,7 +1566,8 @@ introspection. Each module is stored by its dotted import path.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A list containing the dotted paths of all modules in the project.</p>
|
||||
<p>list[str]:
|
||||
A list containing the dotted paths of all modules in the project.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
Reference in New Issue
Block a user