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

docs: refresh doc-forge library and MCP bundle

Browse Source 
- collect regenerated doc-forge combined site (wiki + lib)
- drop stale lib/docforge duplicate subtree
- mcp bundle now uses docs:// module resources
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-12 13:12:55 +05:30
parent bd8ba6e67c
commit 167d44fcfe
107 changed files with 4754 additions and 40058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
doc-forge/lib/models/index.html
View File

@@ -343,6 +343,10 @@
@@ -427,6 +431,52 @@
<li class="md-nav__item">
<a href="../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1542,7 +1592,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.DocObject.signature">signature</span></code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1553,7 +1603,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.DocObject.docstring">docstring</span></code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1564,7 +1614,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.DocObject.members">members</span></code></td>
<td>
<code>Dict[str, <a class="autorefs autorefs-internal" title="docforge.models.object.DocObject" href="object/#docforge.models.object.DocObject">DocObject</a>]</code>
<code>dict[str, <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">
@@ -1634,7 +1684,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code>signature</code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1648,7 +1698,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code>docstring</code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1915,7 +1965,7 @@ introspection.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.Module.docstring">docstring</span></code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1926,7 +1976,7 @@ introspection.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.Module.members">members</span></code></td>
<td>
<code>Dict[str, <a class="autorefs autorefs-internal" title="docforge.models.object.DocObject" href="object/#docforge.models.object.DocObject">DocObject</a>]</code>
<code>dict[str, <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">
@@ -1968,7 +2018,7 @@ introspection.</p>
<tr class="doc-section-item">
<td><code>docstring</code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -2232,7 +2282,7 @@ introspection. Each module is stored by its dotted import path.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.Project.modules">modules</span></code></td>
<td>
<code>Dict[str, <a class="autorefs autorefs-internal" title="docforge.models.module.Module" href="module/#docforge.models.module.Module">Module</a>]</code>
<code>dict[str, <a class="autorefs autorefs-internal" title="docforge.models.module.Module" href="module/#docforge.models.module.Module">Module</a>]</code>
</td>
<td>
<div class="doc-md-description">
@@ -2275,6 +2325,19 @@ introspection. Each module is stored by its dotted import path.</p>
</table>
<details class="example" open>
<summary>Example</summary>
<p>Create a project and register a module:</p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>```python
project = Project(&quot;mypackage&quot;)
project.add_module(module)
```
</code></pre></div></td></tr></table></div>
</details>
<div class="doc doc-children">

65
doc-forge/lib/models/module/index.html
View File

@@ -343,6 +343,10 @@
@@ -427,6 +431,52 @@
<li class="md-nav__item">
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1441,6 +1491,15 @@
model. A <code>Module</code> acts as a container for top-level documented objects
(classes, functions, variables, and other members) discovered during
introspection.</p>
<hr />
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Only public members are stored; private names are filtered by the loader.</li>
</ul>
</details> <hr />
@@ -1498,7 +1557,7 @@ introspection.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.module.Module.docstring">docstring</span></code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1509,7 +1568,7 @@ introspection.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.module.Module.members">members</span></code></td>
<td>
<code>Dict[str, <a class="autorefs autorefs-internal" title="docforge.models.object.DocObject" href="../object/#docforge.models.object.DocObject">DocObject</a>]</code>
<code>dict[str, <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">
@@ -1551,7 +1610,7 @@ introspection.</p>
<tr class="doc-section-item">
<td><code>docstring</code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">

70
doc-forge/lib/models/object/index.html
View File

@@ -343,6 +343,10 @@
@@ -427,6 +431,52 @@
<li class="md-nav__item">
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1441,6 +1491,16 @@
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>
<hr />
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li><code>DocObject</code> instances form a tree mirroring the Python import hierarchy.</li>
<li>Objects are renderer-agnostic and may be consumed by any renderer.</li>
</ul>
</details> <hr />
@@ -1532,7 +1592,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.object.DocObject.signature">signature</span></code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1543,7 +1603,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.object.DocObject.docstring">docstring</span></code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1554,7 +1614,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.object.DocObject.members">members</span></code></td>
<td>
<code>Dict[str, <a class="autorefs autorefs-internal" title="docforge.models.object.DocObject" href="#docforge.models.object.DocObject">DocObject</a>]</code>
<code>dict[str, <a class="autorefs autorefs-internal" title="docforge.models.object.DocObject" href="#docforge.models.object.DocObject">DocObject</a>]</code>
</td>
<td>
<div class="doc-md-description">
@@ -1624,7 +1684,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code>signature</code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1638,7 +1698,7 @@ of modules, classes, and other containers to be represented recursively.</p>
<tr class="doc-section-item">
<td><code>docstring</code></td>
<td>
<code>Optional[str]</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">

75
doc-forge/lib/models/project/index.html
View File

@@ -343,6 +343,10 @@
@@ -427,6 +431,52 @@
<li class="md-nav__item">
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
<span class="md-ellipsis">
Gsdfc Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Guide
</span>
</a>
</li>
</ul>
</nav>
@@ -1458,6 +1508,16 @@
<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>
<hr />
<details class="notes" open>
<summary>Notes</summary>
<ul>
<li>Modules are keyed by their dotted import path.</li>
<li>Objects are renderer-agnostic; the same model feeds every renderer.</li>
</ul>
</details> <hr />
@@ -1514,7 +1574,7 @@ introspection. Each module is stored by its dotted import path.</p>
<tr class="doc-section-item">
<td><code><span title="docforge.models.project.Project.modules">modules</span></code></td>
<td>
<code>Dict[str, <a class="autorefs autorefs-internal" title="docforge.models.module.Module" href="../module/#docforge.models.module.Module">Module</a>]</code>
<code>dict[str, <a class="autorefs autorefs-internal" title="docforge.models.module.Module" href="../module/#docforge.models.module.Module">Module</a>]</code>
</td>
<td>
<div class="doc-md-description">
@@ -1557,6 +1617,19 @@ introspection. Each module is stored by its dotted import path.</p>
</table>
<details class="example" open>
<summary>Example</summary>
<p>Create a project and register a module:</p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>```python
project = Project(&quot;mypackage&quot;)
project.add_module(module)
```
</code></pre></div></td></tr></table></div>
</details>
<div class="doc doc-children">