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

135
doc-forge/lib/loaders/index.html
View File

@@ -9,7 +9,7 @@
<link rel="prev" href="../../wiki/05_development/02_quality_gates/">
<link rel="prev" href="../../wiki/05_development/04_mcp_guide/">
<link rel="next" href="griffe_loader/">
@@ -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>
@@ -1371,6 +1421,31 @@ initial filtering before the data is passed to the core documentation models.</p
code and transform the extracted information into <code>Project</code>, <code>Module</code>,
and <code>DocObject</code> instances used by doc-forge.</p>
<p><span class="doc-section-title">Attributes:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code><span title="docforge.loaders.GriffeLoader._loader">_loader</span></code></td>
<td>
<code><span title="griffe.GriffeLoader">GriffeLoader</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Internal Griffe loader with dedicated module and line collections.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p>Initialize the Griffe-backed loader.</p>
<p>Creates an internal Griffe loader instance with dedicated collections
for modules and source lines.</p>
@@ -1457,6 +1532,52 @@ a doc-forge <code>Module</code> model.</p>
</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>ImportError</code>
</td>
<td>
<div class="doc-md-description">
<p>If the module cannot be loaded by Griffe.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code>KeyError</code>
</td>
<td>
<div class="doc-md-description">
<p>If the loaded module is missing from the module collection.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="example" open>
<summary>Example</summary>
<p>Load a single 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
loader = GriffeLoader()
module = loader.load_module(&quot;mypackage.submodule&quot;)
```
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
@@ -1476,7 +1597,7 @@ a doc-forge <code>Module</code> model.</p>
<span class="normal"><a href="#__codelineno-0-5">5</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">load_project</span><span class="p">(</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a> <span class="n">module_paths</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a> <span class="n">project_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a> <span class="n">skip_import_errors</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a> <span class="n">skip_import_errors</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Project</span>
</span></code></pre></div></td></tr></table></div>
@@ -1502,7 +1623,7 @@ object.</p>
<tr class="doc-section-item">
<td><code>module_paths</code></td>
<td>
<code>List[str]</code>
<code>list[str]</code>
</td>
<td>
<div class="doc-md-description">
@@ -1516,7 +1637,7 @@ object.</p>
<tr class="doc-section-item">
<td><code>project_name</code></td>
<td>
<code>str</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1531,7 +1652,7 @@ name of the first module.</p>
<tr class="doc-section-item">
<td><code>skip_import_errors</code></td>
<td>
<code>bool</code>
<code>bool | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1670,7 +1791,7 @@ package and converts them into dotted module import paths.</p>
<tr class="doc-section-item">
<td><code>project_root</code></td>
<td>
<code><span title="pathlib.Path">Path</span></code>
<code><span title="pathlib.Path">Path</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1701,7 +1822,7 @@ current working directory is used.</p>
</td>
<td>
<div class="doc-md-description">
<p>List[str]:
<p>list[str]:
A sorted list of unique dotted module import paths.</p>
</div>
</td>