This commit is contained in:
@@ -961,6 +961,15 @@
|
||||
<nav class="md-nav" aria-label="renderers">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.renderers--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.renderers--overview" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1117,11 +1126,12 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Renderers layer for doc-forge.</p>
|
||||
<h3 id="docforge.renderers--summary">Summary</h3>
|
||||
<p>Renderers layer for doc-forge.</p>
|
||||
<p>The <code>docforge.renderers</code> package transforms the internal documentation
|
||||
models into files formatted for specific documentation systems.</p>
|
||||
<hr />
|
||||
<h4 id="docforge.renderers--overview">Overview</h4>
|
||||
<h3 id="docforge.renderers--overview">Overview</h3>
|
||||
<p>Renderers consume the doc-forge project model and generate output suitable
|
||||
for documentation tools or machine interfaces.</p>
|
||||
<p>Current implementations:</p>
|
||||
@@ -1133,7 +1143,7 @@ for documentation tools or machine interfaces.</p>
|
||||
by Model Context Protocol (MCP) clients.</li>
|
||||
</ul>
|
||||
<hr />
|
||||
<h4 id="docforge.renderers--extending">Extending</h4>
|
||||
<h3 id="docforge.renderers--extending">Extending</h3>
|
||||
<p>New renderers can be added by implementing the <code>DocRenderer</code> protocol
|
||||
defined in <code>docforge.renderers.base</code>.</p>
|
||||
<hr />
|
||||
@@ -1300,8 +1310,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>
|
||||
|
||||
@@ -1348,12 +1358,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>
|
||||
@@ -1428,12 +1437,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