This commit is contained in:
@@ -368,6 +368,15 @@
|
||||
<nav class="md-nav" aria-label="griffe_loader">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.loaders.griffe_loader--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.loaders.griffe_loader-classes" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1105,6 +1114,15 @@
|
||||
<nav class="md-nav" aria-label="griffe_loader">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.loaders.griffe_loader--summary" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Summary
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#docforge.loaders.griffe_loader-classes" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1228,7 +1246,8 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Utilities for loading and introspecting Python modules using Griffe.</p>
|
||||
<h3 id="docforge.loaders.griffe_loader--summary">Summary</h3>
|
||||
<p>Utilities for loading and introspecting Python modules using Griffe.</p>
|
||||
<p>This module provides the <code>GriffeLoader</code> class and helper utilities used to
|
||||
discover Python modules, introspect their structure, and convert the results
|
||||
into doc-forge documentation models.</p>
|
||||
@@ -1332,13 +1351,13 @@ a doc-forge <code>Module</code> model.</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>Module</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.models.Module" href="../../models/#docforge.models.Module">Module</a></code>
|
||||
</td>
|
||||
<td>
|
||||
@@ -1401,12 +1420,12 @@ object.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>project_name</code></td>
|
||||
<td>
|
||||
<code><span title="typing.Optional">Optional</span>[str]</code>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional override for the project name. Defaults
|
||||
to the top-level name of the first module.</p>
|
||||
<p>Optional override for the project name. Defaults to the top-level
|
||||
name of the first module.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
@@ -1420,8 +1439,7 @@ to the top-level name of the first module.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>If True, modules that fail to load will be
|
||||
skipped instead of raising an error.</p>
|
||||
<p>If True, modules that fail to load will be skipped instead of raising an error.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
@@ -1436,13 +1454,13 @@ skipped instead of raising an error.</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>Project</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="docforge.models.Project" href="../../models/#docforge.models.Project">Project</a></code>
|
||||
</td>
|
||||
<td>
|
||||
@@ -1480,8 +1498,7 @@ skipped instead of raising an error.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>If a module fails to load and
|
||||
<code>skip_import_errors</code> is False.</p>
|
||||
<p>If a module fails to load and <code>skip_import_errors</code> is False.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -1553,12 +1570,12 @@ package and converts them into dotted module import paths.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>project_root</code></td>
|
||||
<td>
|
||||
<code><span title="pathlib.Path">Path</span> | None</code>
|
||||
<code><span title="pathlib.Path">Path</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Root directory used to resolve module paths. If not
|
||||
provided, the current working directory is used.</p>
|
||||
<p>Root directory used to resolve module paths. If not provided, the
|
||||
current working directory is used.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
@@ -1584,7 +1601,8 @@ provided, the current working directory is used.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A sorted list of unique dotted module import paths.</p>
|
||||
<p>List[str]:
|
||||
A sorted list of unique dotted module import paths.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
Reference in New Issue
Block a user