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>
|
||||
|
||||
@@ -1529,27 +1579,10 @@ and their associated Markdown files.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A list of dictionaries representing the MkDocs navigation layout.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>list[dict[str, <span title="typing.Any">Any</span>]]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Each dictionary maps a navigation label to a page or a list of</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>list[dict[str, <span title="typing.Any">Any</span>]]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>pages.</p>
|
||||
<p>list[dict[str, Any]]:
|
||||
A list of dictionaries representing the MkDocs navigation layout.
|
||||
Each dictionary maps a navigation label to a page or a list of
|
||||
pages.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1750,17 +1783,9 @@ generated MkDocs configuration.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A list containing the home document (if defined) and all</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>list[str]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>group pattern entries.</p>
|
||||
<p>list[str]:
|
||||
A list containing the home document (if defined) and all
|
||||
group pattern entries.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1824,13 +1849,13 @@ generated MkDocs configuration.</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>NavSpec</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.nav.spec.NavSpec" href="spec/#docforge.nav.spec.NavSpec">NavSpec</a></code>
|
||||
</td>
|
||||
<td>
|
||||
@@ -2040,22 +2065,23 @@ documentation file paths.</p>
|
||||
<p>Iterate over all files referenced by the navigation structure.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<p><span class="doc-section-title">Yields:</span></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>Path</code></td> <td>
|
||||
<code><span title="collections.abc.Iterable">Iterable</span>[<span title="pathlib.Path">Path</span>]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>An iterable of <code>Path</code> objects representing documentation files.</p>
|
||||
<p>A documentation file referenced by the navigation, including
|
||||
the home page when defined.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -2172,7 +2198,7 @@ the result directly usable in an MkDocs <code>nav</code> block with</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>List[Dict[str, Any]]:
|
||||
<p>list[dict[str, Any]]:
|
||||
Navigation entries compatible with the MkDocs <code>nav</code> configuration.
|
||||
The list is empty if the wiki contains no Markdown files.</p>
|
||||
</div>
|
||||
@@ -2259,13 +2285,13 @@ corresponding <code>NavSpec</code> instance.</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>NavSpec</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.nav.spec.NavSpec" href="spec/#docforge.nav.spec.NavSpec">NavSpec</a></code>
|
||||
</td>
|
||||
<td>
|
||||
@@ -2379,13 +2405,13 @@ that referenced documentation files exist within the documentation root.</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>ResolvedNav</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.nav.resolver.ResolvedNav" href="resolver/#docforge.nav.resolver.ResolvedNav">ResolvedNav</a></code>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -1385,6 +1435,16 @@
|
||||
<p>This module provides the <code>MkDocsNavEmitter</code> class, which converts a
|
||||
<code>ResolvedNav</code> instance into the navigation structure required by the
|
||||
MkDocs <code>nav</code> configuration.</p>
|
||||
<hr />
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<ul>
|
||||
<li>The emitted structure is a list of dictionaries, one per top-level nav
|
||||
entry, matching the MkDocs <code>nav</code> YAML format.</li>
|
||||
</ul>
|
||||
</details> <hr />
|
||||
|
||||
|
||||
|
||||
@@ -1489,27 +1549,10 @@ and their associated Markdown files.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A list of dictionaries representing the MkDocs navigation layout.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>list[dict[str, <span title="typing.Any">Any</span>]]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Each dictionary maps a navigation label to a page or a list of</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>list[dict[str, <span title="typing.Any">Any</span>]]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>pages.</p>
|
||||
<p>list[dict[str, Any]]:
|
||||
A list of dictionaries representing the MkDocs navigation layout.
|
||||
Each dictionary maps a navigation label to a page or a list of
|
||||
pages.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -1432,6 +1482,16 @@
|
||||
<p>Navigation resolution utilities.</p>
|
||||
<p>This module resolves a <code>NavSpec</code> against the filesystem by expanding glob
|
||||
patterns and validating that referenced documentation files exist.</p>
|
||||
<hr />
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<ul>
|
||||
<li>Glob resolution is recursive and returns paths in sorted order.</li>
|
||||
<li>Unmatched patterns raise <code>FileNotFoundError</code> to fail fast on typos.</li>
|
||||
</ul>
|
||||
</details> <hr />
|
||||
|
||||
|
||||
|
||||
@@ -1596,22 +1656,23 @@ documentation file paths.</p>
|
||||
<p>Iterate over all files referenced by the navigation structure.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<p><span class="doc-section-title">Yields:</span></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>Path</code></td> <td>
|
||||
<code><span title="collections.abc.Iterable">Iterable</span>[<span title="pathlib.Path">Path</span>]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>An iterable of <code>Path</code> objects representing documentation files.</p>
|
||||
<p>A documentation file referenced by the navigation, including
|
||||
the home page when defined.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1720,13 +1781,13 @@ that referenced documentation files exist within the documentation root.</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>ResolvedNav</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.nav.resolver.ResolvedNav" href="#docforge.nav.resolver.ResolvedNav">ResolvedNav</a></code>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -1451,6 +1501,17 @@
|
||||
<p>This module defines the <code>NavSpec</code> class, which represents the navigation
|
||||
structure defined by the user in the doc-forge navigation specification
|
||||
(typically <code>docforge.nav.yml</code>).</p>
|
||||
<hr />
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<ul>
|
||||
<li>The spec file supports an optional <code>icon</code> mapping for MkDocs theme
|
||||
customization.</li>
|
||||
<li>All file references in <code>groups</code> are relative to the documentation root.</li>
|
||||
</ul>
|
||||
</details> <hr />
|
||||
|
||||
|
||||
|
||||
@@ -1645,17 +1706,9 @@ generated MkDocs configuration.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A list containing the home document (if defined) and all</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>list[str]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>group pattern entries.</p>
|
||||
<p>list[str]:
|
||||
A list containing the home document (if defined) and all
|
||||
group pattern entries.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1719,13 +1772,13 @@ generated MkDocs configuration.</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>NavSpec</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.nav.spec.NavSpec" href="#docforge.nav.spec.NavSpec">NavSpec</a></code>
|
||||
</td>
|
||||
<td>
|
||||
@@ -1835,13 +1888,13 @@ corresponding <code>NavSpec</code> instance.</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>NavSpec</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.nav.spec.NavSpec" href="#docforge.nav.spec.NavSpec">NavSpec</a></code>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
1515
doc-forge/lib/nav/wiki/index.html
Normal file
1515
doc-forge/lib/nav/wiki/index.html
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user