This commit is contained in:
@@ -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