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

docs: refresh doc-forge split sites (lib + wiki)

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-12 14:23:24 +05:30
parent 167d44fcfe
commit bf83538136
162 changed files with 10183 additions and 22164 deletions
Download Patch File Download Diff File Expand all files Collapse all files

757
doc-forge/wiki/01_overview/index.html
View File

@@ -9,13 +9,13 @@
<link rel="prev" href="../">
<link rel="prev" href="..">
<link rel="next" href="../02_architecture/">
<link rel="icon" href="../../assets/images/favicon.png">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
@@ -24,10 +24,10 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -46,11 +46,9 @@
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -92,7 +90,7 @@
<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">
<a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4zm11 3h5.5L15 1.5zM8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2zm3-4v-2H8v2z"/></svg>
@@ -209,7 +207,7 @@
<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">
<a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4zm11 3h5.5L15 1.5zM8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2zm3-4v-2H8v2z"/></svg>
@@ -227,7 +225,7 @@
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<a href=".." class="md-nav__link">
@@ -308,9 +306,9 @@
</li>
<li class="md-nav__item">
<a href="#combined-build" class="md-nav__link">
<a href="#per-kind-mkdocs-builds" class="md-nav__link">
<span class="md-ellipsis">
Combined build
Per-kind MkDocs builds
</span>
</a>
@@ -553,716 +551,6 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/loaders/" class="md-nav__link ">
<span class="md-ellipsis">
Loaders
</span>
</a>
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Loaders
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/loaders/griffe_loader/" class="md-nav__link">
<span class="md-ellipsis">
Griffe Loader
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/models/" class="md-nav__link ">
<span class="md-ellipsis">
Models
</span>
</a>
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Models
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/models/module/" class="md-nav__link">
<span class="md-ellipsis">
Module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/models/object/" class="md-nav__link">
<span class="md-ellipsis">
Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/models/project/" class="md-nav__link">
<span class="md-ellipsis">
Project
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/nav/" class="md-nav__link ">
<span class="md-ellipsis">
Navigation
</span>
</a>
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9">
<span class="md-nav__icon md-icon"></span>
Navigation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/nav/spec/" class="md-nav__link">
<span class="md-ellipsis">
Spec
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/nav/resolver/" class="md-nav__link">
<span class="md-ellipsis">
Resolver
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/nav/mkdocs/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/renderers/" class="md-nav__link ">
<span class="md-ellipsis">
Renderers
</span>
</a>
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
Renderers
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/renderers/base/" class="md-nav__link">
<span class="md-ellipsis">
Base
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/renderers/mkdocs_renderer/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs Renderer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/renderers/mcp_renderer/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Renderer
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
<div class="md-nav__link md-nav__container">
<a href="../../lib/cli/" class="md-nav__link ">
<span class="md-ellipsis">
CLI
</span>
</a>
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_11">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../lib/cli/main/" class="md-nav__link">
<span class="md-ellipsis">
Main
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/cli/commands/" class="md-nav__link">
<span class="md-ellipsis">
Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/cli/api_utils/" class="md-nav__link">
<span class="md-ellipsis">
Api Utils
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/cli/mcp_utils/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Utils
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../lib/cli/mkdocs_utils/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs Utils
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@@ -1299,9 +587,9 @@
</li>
<li class="md-nav__item">
<a href="#combined-build" class="md-nav__link">
<a href="#per-kind-mkdocs-builds" class="md-nav__link">
<span class="md-ellipsis">
Combined build
Per-kind MkDocs builds
</span>
</a>
@@ -1335,7 +623,7 @@
<h1 id="overview">Overview</h1>
<p><code>docforge</code> turns GSDFC-compliant Python docstrings into maintainable reference
documentation. It never edits source docstrings; it reads them, renders them,
and assembles a single MkDocs site from all available material.</p>
and assembles documentation sites from all available material.</p>
<h2 id="what-it-generates">What it generates</h2>
<table>
<thead>
@@ -1368,15 +656,16 @@ and assembles a single MkDocs site from all available material.</p>
</tr>
</tbody>
</table>
<h2 id="combined-build">Combined build</h2>
<p>One <code>mkdocs.yml</code> and one MkDocs build serve all kinds:</p>
<h2 id="per-kind-mkdocs-builds">Per-kind MkDocs builds</h2>
<p>Each enabled site kind produces its own MkDocs configuration and build:</p>
<ol>
<li>Wiki navigation is derived from the <code>docs/wiki/</code> file structure.</li>
<li>Generated library/API navigation is appended after it.</li>
<li>The wiki <code>index.md</code> becomes the site <code>Home</code>.</li>
<li><code>--mkdocs</code> (lib) writes <code>docs/mkdocs.lib.yml</code> and builds <code>site/lib/</code>.</li>
<li><code>--api</code> writes <code>docs/mkdocs.api.yml</code> and builds <code>site/api/</code>.</li>
<li><code>--wiki</code> writes <code>docs/mkdocs.wiki.yml</code> and builds <code>site/wiki/</code>.</li>
</ol>
<p>Hand-written wiki content is never overwritten or regenerated — only its
navigation is derived automatically.</p>
<p>Every site is self-contained (own theme assets and search index) with
navigation derived or scoped to that kind. Hand-written wiki content is never
overwritten or regenerated — only its navigation is derived automatically.</p>
<h2 id="mcp-bundle">MCP bundle</h2>
<p><code>docs/mcp/**</code> is a self-contained, machine-readable reference generated from
docforge's own GSDFC docstrings. <code>doc-forge serve --mcp --module docforge</code>
@@ -1437,10 +726,10 @@ serves it over MCP. See the <a href="../05_development/04_mcp_guide/">MCP Guide<
<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 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>
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>