docs: refresh doc-forge library and MCP bundle
- 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:
@@ -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>
|
||||
|
||||
@@ -1566,7 +1616,7 @@ site author.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>spec</code></td>
|
||||
<td>
|
||||
<code>dict[<span title="typing.Any">Any</span>, <span title="typing.Any">Any</span>]</code>
|
||||
<code>dict</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1592,7 +1642,7 @@ site author.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>OpenAPIMetadata</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.cli.api_utils.OpenAPIMetadata" href="../../docforge/cli/api_utils/#docforge.cli.api_utils.OpenAPIMetadata">OpenAPIMetadata</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.cli.api_utils.OpenAPIMetadata" href="#docforge.cli.api_utils.OpenAPIMetadata">OpenAPIMetadata</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1643,7 +1693,7 @@ an <code>index.md</code> embedding the swagger UI is generated alongside it.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>spec</code></td>
|
||||
<td>
|
||||
<code>dict[<span title="typing.Any">Any</span>, <span title="typing.Any">Any</span>]</code>
|
||||
<code>dict</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -1396,6 +1446,17 @@
|
||||
<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>
|
||||
<hr />
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<ul>
|
||||
<li>The <code>build</code> command validates requested modes before generating anything.</li>
|
||||
<li><code>--mkdocs</code>, <code>--api</code>, and <code>--wiki</code> share a single MkDocs build; <code>--mcp</code>
|
||||
generates a machine-readable bundle independently.</li>
|
||||
</ul>
|
||||
</details> <hr />
|
||||
|
||||
|
||||
|
||||
@@ -1455,9 +1516,9 @@
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Build documentation artifacts.</p>
|
||||
<p>This command performs the full documentation build pipeline:
|
||||
style of the selected platform, generates renderer-specific
|
||||
documentation sources, and optionally builds the final output.</p>
|
||||
<p>This command runs the full documentation pipeline: it loads Python
|
||||
modules, generates renderer-specific documentation sources, and
|
||||
optionally builds or serves the final output.</p>
|
||||
<p>Depending on the selected options, the build can target:</p>
|
||||
<ul>
|
||||
<li>MkDocs static documentation sites for library reference docs</li>
|
||||
@@ -1467,6 +1528,16 @@ documentation sources, and optionally builds the final output.</p>
|
||||
</ul>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<ul>
|
||||
<li>At least one of <code>--mcp</code>, <code>--mkdocs</code>, <code>--wiki</code>, or <code>--api</code> must be
|
||||
provided.</li>
|
||||
<li><code>--mkdocs</code>, <code>--api</code>, and <code>--wiki</code> are combined into a single MkDocs
|
||||
build, while <code>--mcp</code> emits a machine-readable bundle.</li>
|
||||
</ul>
|
||||
</details>
|
||||
|
||||
<p><span class="doc-section-title">Parameters:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1551,7 +1622,7 @@ documentation sources, and optionally builds the final output.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>module</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1565,7 +1636,7 @@ documentation sources, and optionally builds the final output.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>openapi_spec</code></td>
|
||||
<td>
|
||||
<code>Optional[<span title="pathlib.Path">Path</span>]</code>
|
||||
<code><span title="pathlib.Path">Path</span> | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1579,7 +1650,7 @@ documentation sources, and optionally builds the final output.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>project_name</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1593,7 +1664,7 @@ documentation sources, and optionally builds the final output.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>site_name</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1649,7 +1720,7 @@ documentation sources, and optionally builds the final output.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>template</code></td>
|
||||
<td>
|
||||
<code>Optional[<span title="pathlib.Path">Path</span>]</code>
|
||||
<code><span title="pathlib.Path">Path</span> | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1793,7 +1864,7 @@ documentation sources, and optionally builds the final output.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>module</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1909,7 +1980,7 @@ objects, including modules, classes, functions, and members.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>project_name</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
|
||||
@@ -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>
|
||||
|
||||
|
||||
@@ -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>
|
||||
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -1377,6 +1427,18 @@
|
||||
|
||||
<h3 id="docforge.cli.mcp_utils--summary">Summary</h3>
|
||||
<p>Utilities for working with MCP in the doc-forge CLI.</p>
|
||||
<hr />
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<ul>
|
||||
<li><code>generate_resources</code> produces the bundle consumed by <code>MCPServer</code>:
|
||||
<code>index.json</code>, <code>nav.json</code>, and per-module resources under <code>modules/</code>.</li>
|
||||
<li>Resource URIs use the <code>docs://</code> scheme: <code>docs://index</code>, <code>docs://nav</code>,
|
||||
and <code>docs://modules/{module}</code>.</li>
|
||||
</ul>
|
||||
</details> <hr />
|
||||
|
||||
|
||||
|
||||
@@ -1442,7 +1504,7 @@ documentation generation.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>project_name</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
|
||||
@@ -341,6 +341,10 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -425,6 +429,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>
|
||||
|
||||
@@ -1411,6 +1461,17 @@
|
||||
|
||||
<h3 id="docforge.cli.mkdocs_utils--summary">Summary</h3>
|
||||
<p>Utilities for working with MkDocs in the doc-forge CLI.</p>
|
||||
<hr />
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<ul>
|
||||
<li>A single generated <code>mkdocs.yml</code> serves lib, api, and wiki content with
|
||||
merged navigation. Wiki navigation, when enabled, precedes every other
|
||||
group and its <code>index.md</code> becomes the site <code>Home</code>.</li>
|
||||
</ul>
|
||||
</details> <hr />
|
||||
|
||||
|
||||
|
||||
@@ -1583,7 +1644,7 @@ and hand-written wiki content under a <code>wiki/</code> subdirectory.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>template</code></td>
|
||||
<td>
|
||||
<code>Optional[<span title="pathlib.Path">Path</span>]</code>
|
||||
<code><span title="pathlib.Path">Path</span> | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1627,7 +1688,7 @@ template replaces the built-in templates entirely.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>modes</code></td>
|
||||
<td>
|
||||
<code>Optional[<span title="collections.abc.Iterable">Iterable</span>[str]]</code>
|
||||
<code><span title="collections.abc.Iterable">Iterable</span>[str] | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1644,7 +1705,7 @@ template.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>site_description</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1658,7 +1719,7 @@ template.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>site_author</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1672,7 +1733,7 @@ template.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>wiki_dir</code></td>
|
||||
<td>
|
||||
<code>Optional[<span title="pathlib.Path">Path</span>]</code>
|
||||
<code><span title="pathlib.Path">Path</span> | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1791,7 +1852,7 @@ documentation generation.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>project_name</code></td>
|
||||
<td>
|
||||
<code>Optional[str]</code>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1805,7 +1866,7 @@ documentation generation.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>module_is_source</code></td>
|
||||
<td>
|
||||
<code>Optional[bool]</code>
|
||||
<code>bool | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1820,7 +1881,7 @@ rather than a nested module.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>readme_dir</code></td>
|
||||
<td>
|
||||
<code>Optional[<span title="pathlib.Path">Path</span>]</code>
|
||||
<code><span title="pathlib.Path">Path</span> | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
|
||||
Reference in New Issue
Block a user