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

updated mcp
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-03-08 17:57:34 +05:30
parent 9191de9dff
commit 0e49f02c4c
167 changed files with 7632 additions and 98942 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
libs/doc-forge/site/cli/commands/index.html
View File

@@ -915,6 +915,15 @@
<nav class="md-nav" aria-label="commands">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli.commands--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli.commands-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1069,6 +1078,15 @@
<nav class="md-nav" aria-label="commands">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli.commands--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli.commands-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1156,6 +1174,10 @@
<div class="doc doc-contents first">
<h3 id="docforge.cli.commands--summary">Summary</h3>
<p>Command definitions for the doc-forge CLI.</p>
<p>Provides the CLI structure using Click, including build, serve, and tree commands.</p>
<div class="doc doc-children">
@@ -1241,8 +1263,7 @@
</td>
<td>
<div class="doc-md-description">
<p>Treat the specified module directory as the
project root.</p>
<p>Treat the specified module directory as the project root.</p>
</div>
</td>
<td>
@@ -1298,8 +1319,7 @@ project root.</p>
</td>
<td>
<div class="doc-md-description">
<p>Directory where Markdown documentation sources
will be generated.</p>
<p>Directory where Markdown documentation sources will be generated.</p>
</div>
</td>
<td>

25
libs/doc-forge/site/cli/index.html
View File

@@ -961,6 +961,15 @@
<nav class="md-nav" aria-label="cli">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli--typical-usage" class="md-nav__link">
<span class="md-ellipsis">
@@ -1006,7 +1015,8 @@
<div class="doc doc-contents first">
<p>Command line interface entry point for doc-forge.</p>
<h3 id="docforge.cli--summary">Summary</h3>
<p>Command line interface entry point for doc-forge.</p>
<p>This module exposes the primary CLI entry function used by the
<code>doc-forge</code> command. The actual command implementation resides in
<code>docforge.cli.main</code>, while this module provides a stable import path
@@ -1016,14 +1026,19 @@ generating renderer sources, building documentation sites, exporting
machine-readable documentation bundles, and starting development or MCP
servers.</p>
<hr />
<h4 id="docforge.cli--typical-usage">Typical usage</h4>
<h3 id="docforge.cli--typical-usage">Typical usage</h3>
<p>The CLI is normally invoked through the installed command:</p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>doc-forge &lt;command&gt; [options]
</code></pre></div></td></tr></table></div>
<div class="language-bash 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>doc-forge<span class="w"> </span>&lt;command&gt;<span class="w"> </span><span class="o">[</span>options<span class="o">]</span>
</span></code></pre></div></td></tr></table></div>
<p>Programmatic invocation is also possible:</p>
<p>Example:</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></pre></div></td><td class="code"><div><pre><span></span><code>from docforge.cli import main
<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
from docforge.cli import main
main()
```
</code></pre></div></td></tr></table></div>
<hr />

21
libs/doc-forge/site/cli/main/index.html
View File

@@ -892,6 +892,15 @@
<nav class="md-nav" aria-label="main">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli.main--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli.main-functions" class="md-nav__link">
<span class="md-ellipsis">
@@ -1042,6 +1051,15 @@
<nav class="md-nav" aria-label="main">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli.main--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli.main-functions" class="md-nav__link">
<span class="md-ellipsis">
@@ -1102,7 +1120,8 @@
<div class="doc doc-contents first">
<p>Command-line entry point for the doc-forge CLI.</p>
<h3 id="docforge.cli.main--summary">Summary</h3>
<p>Command-line entry point for the doc-forge CLI.</p>
<p>This module exposes the executable entry point that initializes the
Click command group defined in <code>docforge.cli.commands</code>.</p>

34
libs/doc-forge/site/cli/mcp_utils/index.html
View File

@@ -938,6 +938,15 @@
<nav class="md-nav" aria-label="mcp_utils">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli.mcp_utils--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli.mcp_utils-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1060,6 +1069,15 @@
<nav class="md-nav" aria-label="mcp_utils">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli.mcp_utils--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli.mcp_utils-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1138,6 +1156,9 @@
<div class="doc doc-contents first">
<h3 id="docforge.cli.mcp_utils--summary">Summary</h3>
<p>Utilities for working with MCP in the doc-forge CLI.</p>
<div class="doc doc-children">
@@ -1198,12 +1219,12 @@ documentation generation.</p>
<tr class="doc-section-item">
<td><code>project_name</code></td>
<td>
<code>str | None</code>
<code>Optional[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional override for the project name used in
generated documentation metadata.</p>
<p>Optional override for the project name used in generated
documentation metadata.</p>
</div>
</td>
<td>
@@ -1217,8 +1238,8 @@ generated documentation metadata.</p>
</td>
<td>
<div class="doc-md-description">
<p>Directory where MCP resources (index.json, nav.json,
and module data) will be written.</p>
<p>Directory where MCP resources (index.json, nav.json, and module data)
will be written.</p>
</div>
</td>
<td>
@@ -1310,8 +1331,7 @@ bundle (index.json, nav.json, and modules/).</p>
</td>
<td>
<div class="doc-md-description">
<p>If the MCP documentation bundle is missing
required files or directories.</p>
<p>If the MCP documentation bundle is missing required files or directories.</p>
</div>
</td>
</tr>

44
libs/doc-forge/site/cli/mkdocs_utils/index.html
View File

@@ -959,6 +959,15 @@
<nav class="md-nav" aria-label="mkdocs_utils">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli.mkdocs_utils--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli.mkdocs_utils-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1076,6 +1085,15 @@
<nav class="md-nav" aria-label="mkdocs_utils">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.cli.mkdocs_utils--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.cli.mkdocs_utils-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1172,6 +1190,9 @@
<div class="doc doc-contents first">
<h3 id="docforge.cli.mkdocs_utils--summary">Summary</h3>
<p>Utilities for working with MkDocs in the doc-forge CLI.</p>
<div class="doc doc-children">
@@ -1318,12 +1339,12 @@ specification.</p>
<tr class="doc-section-item">
<td><code>template</code></td>
<td>
<code><span title="pathlib.Path">Path</span> | None</code>
<code>Optional[<span title="pathlib.Path">Path</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional path to a custom MkDocs configuration template.
If not provided, a built-in template will be used.</p>
<p>Optional path to a custom MkDocs configuration template. If not
provided, a built-in template will be used.</p>
</div>
</td>
<td>
@@ -1337,8 +1358,7 @@ If not provided, a built-in template will be used.</p>
</td>
<td>
<div class="doc-md-description">
<p>Destination path where the generated <code>mkdocs.yml</code> file
will be written.</p>
<p>Destination path where the generated <code>mkdocs.yml</code> file will be written.</p>
</div>
</td>
<td>
@@ -1378,8 +1398,7 @@ will be written.</p>
</td>
<td>
<div class="doc-md-description">
<p>If the navigation specification or template
file cannot be found.</p>
<p>If the navigation specification or template file cannot be found.</p>
</div>
</td>
</tr>
@@ -1452,12 +1471,11 @@ documentation generation.</p>
<tr class="doc-section-item">
<td><code>project_name</code></td>
<td>
<code>str | None</code>
<code>Optional[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional override for the project name used in
documentation metadata.</p>
<p>Optional override for the project name used in documentation metadata.</p>
</div>
</td>
<td>
@@ -1467,12 +1485,12 @@ documentation metadata.</p>
<tr class="doc-section-item">
<td><code>module_is_source</code></td>
<td>
<code>bool | None</code>
<code>Optional[bool]</code>
</td>
<td>
<div class="doc-md-description">
<p>If True, treat the specified module directory as
the project root rather than a nested module.</p>
<p>If True, treat the specified module directory as the project root
rather than a nested module.</p>
</div>
</td>
<td>

1440
libs/doc-forge/site/index.html
View File

File diff suppressed because it is too large Load Diff

50
libs/doc-forge/site/loaders/griffe_loader/index.html
View File

@@ -368,6 +368,15 @@
<nav class="md-nav" aria-label="griffe_loader">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.loaders.griffe_loader--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.loaders.griffe_loader-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1105,6 +1114,15 @@
<nav class="md-nav" aria-label="griffe_loader">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.loaders.griffe_loader--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.loaders.griffe_loader-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1228,7 +1246,8 @@
<div class="doc doc-contents first">
<p>Utilities for loading and introspecting Python modules using Griffe.</p>
<h3 id="docforge.loaders.griffe_loader--summary">Summary</h3>
<p>Utilities for loading and introspecting Python modules using Griffe.</p>
<p>This module provides the <code>GriffeLoader</code> class and helper utilities used to
discover Python modules, introspect their structure, and convert the results
into doc-forge documentation models.</p>
@@ -1332,13 +1351,13 @@ a doc-forge <code>Module</code> model.</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" href="../../models/#docforge.models.Module">Module</a></code>
</td>
<td>
@@ -1401,12 +1420,12 @@ object.</p>
<tr class="doc-section-item">
<td><code>project_name</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[str]</code>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional override for the project name. Defaults
to the top-level name of the first module.</p>
<p>Optional override for the project name. Defaults to the top-level
name of the first module.</p>
</div>
</td>
<td>
@@ -1420,8 +1439,7 @@ to the top-level name of the first module.</p>
</td>
<td>
<div class="doc-md-description">
<p>If True, modules that fail to load will be
skipped instead of raising an error.</p>
<p>If True, modules that fail to load will be skipped instead of raising an error.</p>
</div>
</td>
<td>
@@ -1436,13 +1454,13 @@ skipped instead of raising an error.</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>Project</code></td> <td>
<code><a class="autorefs autorefs-internal" title="docforge.models.Project" href="../../models/#docforge.models.Project">Project</a></code>
</td>
<td>
@@ -1480,8 +1498,7 @@ skipped instead of raising an error.</p>
</td>
<td>
<div class="doc-md-description">
<p>If a module fails to load and
<code>skip_import_errors</code> is False.</p>
<p>If a module fails to load and <code>skip_import_errors</code> is False.</p>
</div>
</td>
</tr>
@@ -1553,12 +1570,12 @@ 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> | None</code>
<code><span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Root directory used to resolve module paths. If not
provided, the current working directory is used.</p>
<p>Root directory used to resolve module paths. If not provided, the
current working directory is used.</p>
</div>
</td>
<td>
@@ -1584,7 +1601,8 @@ provided, the current working directory is used.</p>
</td>
<td>
<div class="doc-md-description">
<p>A sorted list of unique dotted module import paths.</p>
<p>List[str]:
A sorted list of unique dotted module import paths.</p>
</div>
</td>
</tr>

43
libs/doc-forge/site/loaders/index.html
View File

@@ -961,6 +961,15 @@
<nav class="md-nav" aria-label="loaders">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.loaders--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.loaders--overview" class="md-nav__link">
<span class="md-ellipsis">
@@ -1093,11 +1102,12 @@
<div class="doc doc-contents first">
<p>Loader layer for doc-forge.</p>
<h3 id="docforge.loaders--summary">Summary</h3>
<p>Loader layer for doc-forge.</p>
<p>The <code>docforge.loaders</code> package is responsible for discovering Python modules
and extracting documentation data using static analysis.</p>
<hr />
<h4 id="docforge.loaders--overview">Overview</h4>
<h3 id="docforge.loaders--overview">Overview</h3>
<p>This layer converts Python source code into an intermediate documentation
model used by doc-forge. It performs module discovery, introspection, and
initial filtering before the data is passed to the core documentation models.</p>
@@ -1210,13 +1220,13 @@ a doc-forge <code>Module</code> model.</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" href="../models/#docforge.models.Module">Module</a></code>
</td>
<td>
@@ -1279,12 +1289,12 @@ object.</p>
<tr class="doc-section-item">
<td><code>project_name</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[str]</code>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional override for the project name. Defaults
to the top-level name of the first module.</p>
<p>Optional override for the project name. Defaults to the top-level
name of the first module.</p>
</div>
</td>
<td>
@@ -1298,8 +1308,7 @@ to the top-level name of the first module.</p>
</td>
<td>
<div class="doc-md-description">
<p>If True, modules that fail to load will be
skipped instead of raising an error.</p>
<p>If True, modules that fail to load will be skipped instead of raising an error.</p>
</div>
</td>
<td>
@@ -1314,13 +1323,13 @@ skipped instead of raising an error.</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>Project</code></td> <td>
<code><a class="autorefs autorefs-internal" title="docforge.models.Project" href="../models/#docforge.models.Project">Project</a></code>
</td>
<td>
@@ -1358,8 +1367,7 @@ skipped instead of raising an error.</p>
</td>
<td>
<div class="doc-md-description">
<p>If a module fails to load and
<code>skip_import_errors</code> is False.</p>
<p>If a module fails to load and <code>skip_import_errors</code> is False.</p>
</div>
</td>
</tr>
@@ -1431,12 +1439,12 @@ 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> | None</code>
<code><span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Root directory used to resolve module paths. If not
provided, the current working directory is used.</p>
<p>Root directory used to resolve module paths. If not provided, the
current working directory is used.</p>
</div>
</td>
<td>
@@ -1462,7 +1470,8 @@ provided, the current working directory is used.</p>
</td>
<td>
<div class="doc-md-description">
<p>A sorted list of unique dotted module import paths.</p>
<p>List[str]:
A sorted list of unique dotted module import paths.</p>
</div>
</td>
</tr>

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

@@ -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>

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

@@ -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>

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

@@ -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>

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

@@ -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>

24
libs/doc-forge/site/renderers/base/index.html
View File

@@ -748,6 +748,15 @@
<nav class="md-nav" aria-label="base">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.base--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers.base-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1096,6 +1105,15 @@
<nav class="md-nav" aria-label="base">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.base--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers.base-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1210,7 +1228,8 @@
<div class="doc doc-contents first">
<p>Renderer base interfaces and configuration models.</p>
<h3 id="docforge.renderers.base--summary">Summary</h3>
<p>Renderer base interfaces and configuration models.</p>
<p>This module defines the base protocol and configuration container used by
doc-forge renderers. Concrete renderer implementations should implement the
<code>DocRenderer</code> protocol.</p>
@@ -1307,8 +1326,7 @@ doc-forge renderers. Concrete renderer implementations should implement the
</td>
<td>
<div class="doc-md-description">
<p>Directory where generated documentation sources
should be written.</p>
<p>Directory where generated documentation sources should be written.</p>
</div>
</td>
<td>

31
libs/doc-forge/site/renderers/index.html
View File

@@ -961,6 +961,15 @@
<nav class="md-nav" aria-label="renderers">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers--overview" class="md-nav__link">
<span class="md-ellipsis">
@@ -1117,11 +1126,12 @@
<div class="doc doc-contents first">
<p>Renderers layer for doc-forge.</p>
<h3 id="docforge.renderers--summary">Summary</h3>
<p>Renderers layer for doc-forge.</p>
<p>The <code>docforge.renderers</code> package transforms the internal documentation
models into files formatted for specific documentation systems.</p>
<hr />
<h4 id="docforge.renderers--overview">Overview</h4>
<h3 id="docforge.renderers--overview">Overview</h3>
<p>Renderers consume the doc-forge project model and generate output suitable
for documentation tools or machine interfaces.</p>
<p>Current implementations:</p>
@@ -1133,7 +1143,7 @@ for documentation tools or machine interfaces.</p>
by Model Context Protocol (MCP) clients.</li>
</ul>
<hr />
<h4 id="docforge.renderers--extending">Extending</h4>
<h3 id="docforge.renderers--extending">Extending</h3>
<p>New renderers can be added by implementing the <code>DocRenderer</code> protocol
defined in <code>docforge.renderers.base</code>.</p>
<hr />
@@ -1300,8 +1310,8 @@ allowing MkDocs to render API documentation dynamically.</p>
<p>Generate a <code>README.md</code> file from the root module docstring.</p>
<p>Behavior:</p>
<ul>
<li>If <code>module_is_source</code> is True, <code>README.md</code> is written to the
project root directory.</li>
<li>If <code>module_is_source</code> is True, <code>README.md</code> is written to the project
root directory.</li>
<li>If False, README generation is currently not implemented.</li>
</ul>
@@ -1348,12 +1358,11 @@ allowing MkDocs to render API documentation dynamically.</p>
<tr class="doc-section-item">
<td><code>module_is_source</code></td>
<td>
<code>bool | None</code>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether the module is treated as the project
source root.</p>
<p>Whether the module is treated as the project source root.</p>
</div>
</td>
<td>
@@ -1428,12 +1437,12 @@ specified output directory.</p>
<tr class="doc-section-item">
<td><code>module_is_source</code></td>
<td>
<code>bool | None</code>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>If True, treat the specified module as the
documentation root rather than nesting it inside a folder.</p>
<p>If True, treat the specified module as the documentation root
rather than nesting it inside a folder.</p>
</div>
</td>
<td>

23
libs/doc-forge/site/renderers/mcp_renderer/index.html
View File

@@ -794,6 +794,15 @@
<nav class="md-nav" aria-label="mcp_renderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mcp_renderer--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers.mcp_renderer-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1072,6 +1081,15 @@
<nav class="md-nav" aria-label="mcp_renderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mcp_renderer--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers.mcp_renderer-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1162,6 +1180,11 @@
<div class="doc doc-contents first">
<h3 id="docforge.renderers.mcp_renderer--summary">Summary</h3>
<p>MCP renderer implementation.</p>
<p>This module defines the <code>MCPRenderer</code> class, which generates documentation
resources compatible with the Model Context Protocol (MCP).</p>
<div class="doc doc-children">

36
libs/doc-forge/site/renderers/mkdocs_renderer/index.html
View File

@@ -771,6 +771,15 @@
<nav class="md-nav" aria-label="mkdocs_renderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1081,6 +1090,15 @@
<nav class="md-nav" aria-label="mkdocs_renderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1180,7 +1198,8 @@
<div class="doc doc-contents first">
<p>MkDocs renderer implementation.</p>
<h3 id="docforge.renderers.mkdocs_renderer--summary">Summary</h3>
<p>MkDocs renderer implementation.</p>
<p>This module defines the <code>MkDocsRenderer</code> class, which generates Markdown
documentation sources compatible with MkDocs Material and the mkdocstrings
plugin.</p>
@@ -1250,8 +1269,8 @@ allowing MkDocs to render API documentation dynamically.</p>
<p>Generate a <code>README.md</code> file from the root module docstring.</p>
<p>Behavior:</p>
<ul>
<li>If <code>module_is_source</code> is True, <code>README.md</code> is written to the
project root directory.</li>
<li>If <code>module_is_source</code> is True, <code>README.md</code> is written to the project
root directory.</li>
<li>If False, README generation is currently not implemented.</li>
</ul>
@@ -1298,12 +1317,11 @@ allowing MkDocs to render API documentation dynamically.</p>
<tr class="doc-section-item">
<td><code>module_is_source</code></td>
<td>
<code>bool | None</code>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether the module is treated as the project
source root.</p>
<p>Whether the module is treated as the project source root.</p>
</div>
</td>
<td>
@@ -1378,12 +1396,12 @@ specified output directory.</p>
<tr class="doc-section-item">
<td><code>module_is_source</code></td>
<td>
<code>bool | None</code>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>If True, treat the specified module as the
documentation root rather than nesting it inside a folder.</p>
<p>If True, treat the specified module as the documentation root
rather than nesting it inside a folder.</p>
</div>
</td>
<td>

2
libs/doc-forge/site/search/search_index.json
View File

File diff suppressed because one or more lines are too long

21
libs/doc-forge/site/servers/index.html
View File

@@ -957,6 +957,15 @@
<nav class="md-nav" aria-label="servers">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.servers--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.servers-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1047,7 +1056,8 @@
<div class="doc doc-contents first">
<p>Server layer for doc-forge.</p>
<h3 id="docforge.servers--summary">Summary</h3>
<p>Server layer for doc-forge.</p>
<p>This module exposes server implementations used to provide live access
to generated documentation resources. Currently, it includes the MCP
documentation server.</p>
@@ -1104,9 +1114,8 @@ MCP endpoints backed by JSON files generated by the MCP renderer.</p>
</td>
<td>
<div class="doc-md-description">
<p>Directory containing the generated MCP documentation
bundle (for example <code>index.json</code>, <code>nav.json</code>, and
<code>modules/</code>).</p>
<p>Directory containing the generated MCP documentation bundle
(for example <code>index.json</code>, <code>nav.json</code>, and <code>modules/</code>).</p>
</div>
</td>
<td>
@@ -1177,8 +1186,8 @@ bundle (for example <code>index.json</code>, <code>nav.json</code>, and
</td>
<td>
<div class="doc-md-description">
<p>Transport mechanism used by the MCP server. Supported
options include <code>stdio</code>, <code>sse</code>, and <code>streamable-http</code>.</p>
<p>Transport mechanism used by the MCP server. Supported options
include <code>stdio</code>, <code>sse</code>, and <code>streamable-http</code>.</p>
</div>
</td>
<td>

23
libs/doc-forge/site/servers/mcp_server/index.html
View File

@@ -957,6 +957,15 @@
<nav class="md-nav" aria-label="mcp_server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.servers.mcp_server--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.servers.mcp_server-classes" class="md-nav__link">
<span class="md-ellipsis">
@@ -1047,6 +1056,11 @@
<div class="doc doc-contents first">
<h3 id="docforge.servers.mcp_server--summary">Summary</h3>
<p>MCP server implementation.</p>
<p>This module defines the <code>MCPServer</code> class, which serves pre-generated
documentation bundles through the Model Context Protocol (MCP).</p>
<div class="doc doc-children">
@@ -1098,9 +1112,8 @@ MCP endpoints backed by JSON files generated by the MCP renderer.</p>
</td>
<td>
<div class="doc-md-description">
<p>Directory containing the generated MCP documentation
bundle (for example <code>index.json</code>, <code>nav.json</code>, and
<code>modules/</code>).</p>
<p>Directory containing the generated MCP documentation bundle
(for example <code>index.json</code>, <code>nav.json</code>, and <code>modules/</code>).</p>
</div>
</td>
<td>
@@ -1171,8 +1184,8 @@ bundle (for example <code>index.json</code>, <code>nav.json</code>, and
</td>
<td>
<div class="doc-md-description">
<p>Transport mechanism used by the MCP server. Supported
options include <code>stdio</code>, <code>sse</code>, and <code>streamable-http</code>.</p>
<p>Transport mechanism used by the MCP server. Supported options
include <code>stdio</code>, <code>sse</code>, and <code>streamable-http</code>.</p>
</div>
</td>
<td>

BIN
libs/doc-forge/site/sitemap.xml.gz
View File

Binary file not shown.