This commit is contained in:
@@ -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>
|
||||
|
||||
@@ -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 <command> [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><command><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 />
|
||||
|
||||
|
||||
@@ -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>
|
||||
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
Reference in New Issue
Block a user