aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated doc forge docs
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-03-07 16:24:14 +05:30
parent 91baa41bee
commit 8701bf92ac
26 changed files with 7831 additions and 8208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

638
libs/doc-forge/site/renderers/mkdocs_renderer/index.html
View File

@@ -86,7 +86,9 @@
<header class="md-header" data-md-component="header">
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -151,12 +153,19 @@
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
@@ -182,136 +191,6 @@
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../loaders/" class="md-tabs__link">
Loaders
</a>
</li>
<li class="md-tabs__item">
<a href="../../models/" class="md-tabs__link">
Models
</a>
</li>
<li class="md-tabs__item">
<a href="../../nav/" class="md-tabs__link">
Navigation
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../" class="md-tabs__link">
Renderers
</a>
</li>
<li class="md-tabs__item">
<a href="../../cli/" class="md-tabs__link">
CLI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
@@ -325,10 +204,8 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
@@ -371,13 +248,23 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -386,8 +273,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../loaders/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -396,8 +284,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
@@ -407,27 +301,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../loaders/" class="md-nav__link">
<span class="md-ellipsis">
Loaders
</span>
</a>
</li>
@@ -467,13 +340,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -482,8 +369,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../models/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -492,8 +380,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
@@ -503,27 +397,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../models/" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
@@ -609,13 +482,27 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -624,8 +511,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../nav/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -634,8 +522,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
@@ -645,27 +539,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../nav/" class="md-nav__link">
<span class="md-ellipsis">
Nav
</span>
</a>
</li>
@@ -752,6 +625,18 @@
@@ -759,7 +644,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -769,8 +653,9 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
@@ -779,8 +664,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
@@ -790,27 +681,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Renderers
</span>
</a>
</li>
@@ -902,6 +772,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer.MkDocsRenderer" class="md-nav__link">
<span class="md-ellipsis">
MkDocsRenderer
@@ -911,6 +791,25 @@
<nav class="md-nav" aria-label="MkDocsRenderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer.MkDocsRenderer-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme" class="md-nav__link">
<span class="md-ellipsis">
generate_readme
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources" class="md-nav__link">
<span class="md-ellipsis">
@@ -928,6 +827,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -977,13 +886,29 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -992,8 +917,9 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<div class="md-nav__link md-nav__container">
<a href="../../cli/" class="md-nav__link ">
<span class="md-ellipsis">
@@ -1002,8 +928,14 @@
</span>
<span class="md-nav__icon md-icon"></span>
</label>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
@@ -1013,27 +945,6 @@
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cli/" class="md-nav__link">
<span class="md-ellipsis">
Cli
</span>
</a>
</li>
@@ -1171,6 +1082,16 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer.MkDocsRenderer" class="md-nav__link">
<span class="md-ellipsis">
MkDocsRenderer
@@ -1180,6 +1101,25 @@
<nav class="md-nav" aria-label="MkDocsRenderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer.MkDocsRenderer-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme" class="md-nav__link">
<span class="md-ellipsis">
generate_readme
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources" class="md-nav__link">
<span class="md-ellipsis">
@@ -1197,6 +1137,16 @@
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1223,20 +1173,23 @@
<h2 id="docforge.renderers.mkdocs_renderer" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">docforge.renderers.mkdocs_renderer</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">docforge.renderers.mkdocs_renderer</span>
</h2>
<div class="doc doc-contents first">
<p>MkDocsRenderer</p>
<p>Generates Markdown source files compatible with MkDocs Material
and mkdocstrings, ensuring:</p>
<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>
<p>The renderer ensures a consistent documentation structure by:</p>
<ul>
<li>Root index.md always exists</li>
<li>Parent package indexes are created automatically</li>
<li>Child modules are linked in parent index files</li>
<li>Creating a root <code>index.md</code> if one does not exist</li>
<li>Generating package index pages automatically</li>
<li>Linking child modules within parent package pages</li>
<li>Optionally generating <code>README.md</code> from the root package docstring</li>
</ul>
@@ -1248,24 +1201,25 @@ and mkdocstrings, ensuring:</p>
<h3 id="docforge.renderers.mkdocs_renderer-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="docforge.renderers.mkdocs_renderer.MkDocsRenderer" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">MkDocsRenderer</span>
<h4 id="docforge.renderers.mkdocs_renderer.MkDocsRenderer" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">MkDocsRenderer</span>
</h3>
</h4>
<div class="doc doc-contents ">
<p>Renderer that generates Markdown source files formatted for the MkDocs
'mkdocstrings' plugin.</p>
<p>Renderer that produces Markdown documentation for MkDocs.</p>
<p>Generated pages use mkdocstrings directives to reference Python modules,
allowing MkDocs to render API documentation dynamically.</p>
@@ -1278,23 +1232,28 @@ and mkdocstrings, ensuring:</p>
<h5 id="docforge.renderers.mkdocs_renderer.MkDocsRenderer-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h4 id="docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">generate_sources</span>
<h6 id="docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">generate_readme</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">module_is_source</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
</h6>
<div class="language-python doc-signature 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><span class="nf">generate_readme</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">docs_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">module_is_source</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Produce a set of Markdown files in the output directory based on the
provided Project models.</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 False, README generation is currently not implemented.</li>
</ul>
<p><span class="doc-section-title">Parameters:</span></p>
@@ -1315,7 +1274,7 @@ provided Project models.</p>
</td>
<td>
<div class="doc-md-description">
<p>The project models to render.</p>
<p>Project model containing documentation metadata.</p>
</div>
</td>
<td>
@@ -1323,13 +1282,13 @@ provided Project models.</p>
</td>
</tr>
<tr class="doc-section-item">
<td><code>out_dir</code></td>
<td><code>docs_dir</code></td>
<td>
<code><span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Target directory for documentation files.</p>
<p>Directory containing generated documentation sources.</p>
</div>
</td>
<td>
@@ -1343,7 +1302,88 @@ provided Project models.</p>
</td>
<td>
<div class="doc-md-description">
<p>Module is the source folder and to be treated as the root folder.</p>
<p>Whether the module is treated as the project
source root.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc doc-object doc-function">
<h6 id="docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">generate_sources</span>
</h6>
<div class="language-python doc-signature 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><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">module_is_source</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Generate Markdown documentation files for a project.</p>
<p>This method renders a documentation structure from the provided
project model and writes the resulting Markdown files to the
specified output directory.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<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>
<div class="doc-md-description">
<p>Project model containing modules to document.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>out_dir</code></td>
<td>
<code><span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Directory where generated Markdown files will be written.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>module_is_source</code></td>
<td>
<code>bool | None</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>
</div>
</td>
<td>
@@ -1390,6 +1430,8 @@ provided Project models.</p>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
@@ -1427,7 +1469,7 @@ provided Project models.</p>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>