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