docs: refresh doc-forge split sites (lib + wiki)
This commit is contained in:
@@ -6,11 +6,11 @@
|
|||||||
# static: docs already vendored inside this repository (never collected)
|
# static: docs already vendored inside this repository (never collected)
|
||||||
#
|
#
|
||||||
# Each repo may provide any of the doc kinds: lib, api, wiki (web sites) and mcp (MCP bundle).
|
# Each repo may provide any of the doc kinds: lib, api, wiki (web sites) and mcp (MCP bundle).
|
||||||
|
# Each site is copied whole from the repo's `site/` dir.
|
||||||
# Served layout (flat, one dir per repo; no redirects):
|
# Served layout (flat, one dir per repo; no redirects):
|
||||||
# lib -> /<repo>/lib/
|
# lib -> /<repo>/lib/
|
||||||
# api -> /<repo>/api/ (or /<repo>/ when the site has a root index.html)
|
# api -> /<repo>/api/
|
||||||
# wiki -> /<repo>/ when the wiki is the whole site (e.g. mongo-ops)
|
# wiki -> /<repo>/wiki/
|
||||||
# -> /<repo>/wiki/ in combined sites (e.g. doc-forge with lib + wiki)
|
|
||||||
# mcp -> MCP server on its configured port
|
# mcp -> MCP server on its configured port
|
||||||
# The docs homepage shows one card per repo, grouped by its `section`
|
# The docs homepage shows one card per repo, grouped by its `section`
|
||||||
# (apps, tutorial, services, libraries); card links cover the repo's kinds.
|
# (apps, tutorial, services, libraries); card links cover the repo's kinds.
|
||||||
|
|||||||
@@ -218,7 +218,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/wiki/" class="md-nav__link">
|
<a href="/." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -236,248 +236,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="/wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="/wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="/wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="/wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="/wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="/wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="/wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="/wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -505,11 +263,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
<a href="/lib/loaders/" class="md-nav__link ">
|
<a href="/loaders/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -522,14 +280,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -544,7 +302,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/loaders/griffe_loader/" class="md-nav__link">
|
<a href="/loaders/griffe_loader/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -601,11 +359,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
<a href="/lib/models/" class="md-nav__link ">
|
<a href="/models/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -618,14 +376,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -640,7 +398,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/models/module/" class="md-nav__link">
|
<a href="/models/module/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -663,7 +421,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/models/object/" class="md-nav__link">
|
<a href="/models/object/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -686,7 +444,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/models/project/" class="md-nav__link">
|
<a href="/models/project/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -743,11 +501,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
<a href="/lib/nav/" class="md-nav__link ">
|
<a href="/nav/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -760,14 +518,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -782,7 +540,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/nav/spec/" class="md-nav__link">
|
<a href="/nav/spec/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -805,7 +563,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/nav/resolver/" class="md-nav__link">
|
<a href="/nav/resolver/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -828,7 +586,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/nav/mkdocs/" class="md-nav__link">
|
<a href="/nav/mkdocs/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -885,11 +643,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
<a href="/lib/renderers/" class="md-nav__link ">
|
<a href="/renderers/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -902,14 +660,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -924,7 +682,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/renderers/base/" class="md-nav__link">
|
<a href="/renderers/base/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -947,7 +705,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/renderers/mkdocs_renderer/" class="md-nav__link">
|
<a href="/renderers/mkdocs_renderer/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -970,7 +728,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/renderers/mcp_renderer/" class="md-nav__link">
|
<a href="/renderers/mcp_renderer/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1031,11 +789,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
<a href="/lib/cli/" class="md-nav__link ">
|
<a href="/cli/" class="md-nav__link ">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1048,14 +806,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1070,7 +828,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/cli/main/" class="md-nav__link">
|
<a href="/cli/main/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1093,7 +851,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/cli/commands/" class="md-nav__link">
|
<a href="/cli/commands/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1116,7 +874,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/cli/api_utils/" class="md-nav__link">
|
<a href="/cli/api_utils/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1139,7 +897,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/cli/mcp_utils/" class="md-nav__link">
|
<a href="/cli/mcp_utils/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1162,7 +920,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="/lib/cli/mkdocs_utils/" class="md-nav__link">
|
<a href="/cli/mkdocs_utils/" class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../mcp_utils/">
|
<link rel="next" href="../mcp_utils/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1883,10 +1641,10 @@ sources are written.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../api_utils/">
|
<link rel="next" href="../api_utils/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1453,8 +1211,9 @@
|
|||||||
<summary>Notes</summary>
|
<summary>Notes</summary>
|
||||||
<ul>
|
<ul>
|
||||||
<li>The <code>build</code> command validates requested modes before generating anything.</li>
|
<li>The <code>build</code> command validates requested modes before generating anything.</li>
|
||||||
<li><code>--mkdocs</code>, <code>--api</code>, and <code>--wiki</code> share a single MkDocs build; <code>--mcp</code>
|
<li><code>--mkdocs</code>, <code>--api</code>, and <code>--wiki</code> each emit their own MkDocs config and
|
||||||
generates a machine-readable bundle independently.</li>
|
build (<code>docs/mkdocs.{kind}.yml</code> into <code>site/{kind}</code>); <code>--mcp</code> generates a
|
||||||
|
machine-readable bundle independently.</li>
|
||||||
</ul>
|
</ul>
|
||||||
</details> <hr />
|
</details> <hr />
|
||||||
|
|
||||||
@@ -1493,8 +1252,7 @@
|
|||||||
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
|
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
|
||||||
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
||||||
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
||||||
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
<span class="normal"><a href="#__codelineno-0-16">16</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">build</span><span class="p">(</span>
|
||||||
<span class="normal"><a href="#__codelineno-0-17">17</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">build</span><span class="p">(</span>
|
|
||||||
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a> <span class="n">mcp</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a> <span class="n">mcp</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a> <span class="n">mkdocs</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a> <span class="n">mkdocs</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a> <span class="n">api</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a> <span class="n">api</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
||||||
@@ -1508,9 +1266,8 @@
|
|||||||
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12"></a> <span class="n">wiki_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12"></a> <span class="n">wiki_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13"></a> <span class="n">nav_file</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13"></a> <span class="n">nav_file</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14"></a> <span class="n">template</span><span class="p">:</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14"></a> <span class="n">template</span><span class="p">:</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15"></a> <span class="n">mkdocs_yml</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15"></a> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16"></a> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
||||||
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
||||||
</span></code></pre></div></td></tr></table></div>
|
</span></code></pre></div></td></tr></table></div>
|
||||||
|
|
||||||
<div class="doc doc-contents ">
|
<div class="doc doc-contents ">
|
||||||
@@ -1518,14 +1275,16 @@
|
|||||||
<p>Build documentation artifacts.</p>
|
<p>Build documentation artifacts.</p>
|
||||||
<p>This command runs the full documentation pipeline: it loads Python
|
<p>This command runs the full documentation pipeline: it loads Python
|
||||||
modules, generates renderer-specific documentation sources, and
|
modules, generates renderer-specific documentation sources, and
|
||||||
optionally builds or serves the final output.</p>
|
optionally builds the final output.</p>
|
||||||
<p>Depending on the selected options, the build can target:</p>
|
<p>Depending on the selected options, the build can target:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>MkDocs static documentation sites for library reference docs</li>
|
<li>A lib MkDocs site (<code>--mkdocs</code>) for library reference docs</li>
|
||||||
<li>Swagger-enabled API docs generated from an OpenAPI spec</li>
|
<li>A swagger-enabled API MkDocs site (<code>--api</code>) built from an OpenAPI spec</li>
|
||||||
<li>Hand-written wiki pages included in the MkDocs site</li>
|
<li>A wiki MkDocs site (<code>--wiki</code>) built from hand-written markdown</li>
|
||||||
<li>MCP structured documentation resources</li>
|
<li>MCP structured documentation resources (<code>--mcp</code>)</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<p>Each enabled site kind produces its own MkDocs configuration
|
||||||
|
(<code>docs/mkdocs.{kind}.yml</code>) and its own build (<code>site/{kind}</code>).</p>
|
||||||
|
|
||||||
|
|
||||||
<details class="notes" open>
|
<details class="notes" open>
|
||||||
@@ -1533,8 +1292,8 @@ optionally builds or serves the final output.</p>
|
|||||||
<ul>
|
<ul>
|
||||||
<li>At least one of <code>--mcp</code>, <code>--mkdocs</code>, <code>--wiki</code>, or <code>--api</code> must be
|
<li>At least one of <code>--mcp</code>, <code>--mkdocs</code>, <code>--wiki</code>, or <code>--api</code> must be
|
||||||
provided.</li>
|
provided.</li>
|
||||||
<li><code>--mkdocs</code>, <code>--api</code>, and <code>--wiki</code> are combined into a single MkDocs
|
<li><code>--mkdocs</code>, <code>--api</code>, and <code>--wiki</code> emit independent MkDocs builds,
|
||||||
build, while <code>--mcp</code> emits a machine-readable bundle.</li>
|
while <code>--mcp</code> emits a machine-readable bundle.</li>
|
||||||
</ul>
|
</ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
@@ -1570,7 +1329,7 @@ optionally builds or serves the final output.</p>
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div class="doc-md-description">
|
<div class="doc-md-description">
|
||||||
<p>Enable MkDocs library documentation generation.</p>
|
<p>Enable the lib MkDocs documentation generation.</p>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
@@ -1598,7 +1357,7 @@ optionally builds or serves the final output.</p>
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div class="doc-md-description">
|
<div class="doc-md-description">
|
||||||
<p>Include a hand-written wiki directory in the MkDocs site.</p>
|
<p>Build a hand-written wiki directory as its own MkDocs site.</p>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
@@ -1668,7 +1427,7 @@ optionally builds or serves the final output.</p>
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div class="doc-md-description">
|
<div class="doc-md-description">
|
||||||
<p>Display name for the MkDocs site.</p>
|
<p>Display name for the lib and wiki MkDocs sites.</p>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
@@ -1682,7 +1441,7 @@ optionally builds or serves the final output.</p>
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div class="doc-md-description">
|
<div class="doc-md-description">
|
||||||
<p>Shared documentation root used as the MkDocs <code>docs_dir</code>.</p>
|
<p>Shared documentation root used for generated sources.</p>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
@@ -1731,20 +1490,6 @@ optionally builds or serves the final output.</p>
|
|||||||
<em>required</em>
|
<em>required</em>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="doc-section-item">
|
|
||||||
<td><code>mkdocs_yml</code></td>
|
|
||||||
<td>
|
|
||||||
<code><span title="pathlib.Path">Path</span></code>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div class="doc-md-description">
|
|
||||||
<p>Output path for the generated MkDocs configuration.</p>
|
|
||||||
</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<em>required</em>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr class="doc-section-item">
|
<tr class="doc-section-item">
|
||||||
<td><code>out_dir</code></td>
|
<td><code>out_dir</code></td>
|
||||||
<td>
|
<td>
|
||||||
@@ -1797,19 +1542,25 @@ optionally builds or serves the final output.</p>
|
|||||||
|
|
||||||
|
|
||||||
</h4>
|
</h4>
|
||||||
<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>
|
<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>
|
||||||
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
|
<span class="normal"><a href="#__codelineno-0-2"> 2</a></span>
|
||||||
<span class="normal"><a href="#__codelineno-0-3">3</a></span>
|
<span class="normal"><a href="#__codelineno-0-3"> 3</a></span>
|
||||||
<span class="normal"><a href="#__codelineno-0-4">4</a></span>
|
<span class="normal"><a href="#__codelineno-0-4"> 4</a></span>
|
||||||
<span class="normal"><a href="#__codelineno-0-5">5</a></span>
|
<span class="normal"><a href="#__codelineno-0-5"> 5</a></span>
|
||||||
<span class="normal"><a href="#__codelineno-0-6">6</a></span>
|
<span class="normal"><a href="#__codelineno-0-6"> 6</a></span>
|
||||||
<span class="normal"><a href="#__codelineno-0-7">7</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">serve</span><span class="p">(</span>
|
<span class="normal"><a href="#__codelineno-0-7"> 7</a></span>
|
||||||
|
<span class="normal"><a href="#__codelineno-0-8"> 8</a></span>
|
||||||
|
<span class="normal"><a href="#__codelineno-0-9"> 9</a></span>
|
||||||
|
<span class="normal"><a href="#__codelineno-0-10">10</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">serve</span><span class="p">(</span>
|
||||||
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a> <span class="n">mcp</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a> <span class="n">mcp</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a> <span class="n">mkdocs</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a> <span class="n">mkdocs</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a> <span class="n">module</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a> <span class="n">lib</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a> <span class="n">mkdocs_yml</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a> <span class="n">api</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6"></a> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6"></a> <span class="n">wiki</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
|
||||||
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7"></a> <span class="n">module</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
||||||
|
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8"></a> <span class="n">mkdocs_yml</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||||
|
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9"></a> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||||
|
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
||||||
</span></code></pre></div></td></tr></table></div>
|
</span></code></pre></div></td></tr></table></div>
|
||||||
|
|
||||||
<div class="doc doc-contents ">
|
<div class="doc doc-contents ">
|
||||||
@@ -1817,9 +1568,12 @@ optionally builds or serves the final output.</p>
|
|||||||
<p>Serve generated documentation locally.</p>
|
<p>Serve generated documentation locally.</p>
|
||||||
<p>Depending on the selected mode, this command starts either:</p>
|
<p>Depending on the selected mode, this command starts either:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>A MkDocs development server for browsing documentation</li>
|
<li>A MkDocs development server for browsing a site, or</li>
|
||||||
<li>An MCP server exposing structured documentation resources</li>
|
<li>An MCP server exposing structured documentation resources</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<p>The kind flags (<code>--lib</code>, <code>--api</code>, <code>--wiki</code>) select the generated
|
||||||
|
per-kind config (<code>docs/mkdocs.{kind}.yml</code>); <code>--mkdocs</code> serves the config
|
||||||
|
passed via <code>--mkdocs-yml</code>.</p>
|
||||||
|
|
||||||
|
|
||||||
<p><span class="doc-section-title">Parameters:</span></p>
|
<p><span class="doc-section-title">Parameters:</span></p>
|
||||||
@@ -1854,7 +1608,49 @@ optionally builds or serves the final output.</p>
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div class="doc-md-description">
|
<div class="doc-md-description">
|
||||||
<p>Serve the MkDocs development site.</p>
|
<p>Serve the MkDocs development site from <code>--mkdocs-yml</code>.</p>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<em>required</em>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr class="doc-section-item">
|
||||||
|
<td><code>lib</code></td>
|
||||||
|
<td>
|
||||||
|
<code>bool</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div class="doc-md-description">
|
||||||
|
<p>Serve the lib MkDocs site.</p>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<em>required</em>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr class="doc-section-item">
|
||||||
|
<td><code>api</code></td>
|
||||||
|
<td>
|
||||||
|
<code>bool</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div class="doc-md-description">
|
||||||
|
<p>Serve the API MkDocs site.</p>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<em>required</em>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr class="doc-section-item">
|
||||||
|
<td><code>wiki</code></td>
|
||||||
|
<td>
|
||||||
|
<code>bool</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div class="doc-md-description">
|
||||||
|
<p>Serve the wiki MkDocs site.</p>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
@@ -2061,10 +1857,10 @@ objects, including modules, classes, functions, and members.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="main/">
|
<link rel="next" href="main/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../wiki/" class="md-nav__link">
|
<a href=".." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link md-nav__link--active" for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link md-nav__link--active" for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1386,10 +1144,10 @@ main()
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../commands/">
|
<link rel="next" href="../commands/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1491,10 +1249,10 @@ from the command line.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../mkdocs_utils/">
|
<link rel="next" href="../mkdocs_utils/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1690,10 +1448,10 @@ bundle (index.json, nav.json, and modules/).</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../../models/">
|
<link rel="next" href="../../models/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -246,248 +246,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -763,7 +521,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -780,14 +538,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -905,7 +663,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -922,14 +680,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -1047,7 +805,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1064,14 +822,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1193,7 +951,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1210,14 +968,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -2061,10 +1819,10 @@ A sorted list of unique dotted module import paths.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -9,13 +9,13 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="prev" href="../../wiki/05_development/04_mcp_guide/">
|
<link rel="prev" href="..">
|
||||||
|
|
||||||
|
|
||||||
<link rel="next" href="griffe_loader/">
|
<link rel="next" href="griffe_loader/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../wiki/" class="md-nav__link">
|
<a href=".." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -246,248 +246,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link md-nav__link--active" for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link md-nav__link--active" for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1920,10 +1678,10 @@ A sorted list of unique dotted module import paths.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="module/">
|
<link rel="next" href="module/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../wiki/" class="md-nav__link">
|
<a href=".." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link md-nav__link--active" for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link md-nav__link--active" for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -2650,10 +2408,10 @@ A list containing the dotted paths of all modules in the project.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../object/">
|
<link rel="next" href="../object/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -890,7 +648,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -907,14 +665,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -1032,7 +790,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1049,14 +807,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1178,7 +936,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1195,14 +953,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1894,10 +1652,10 @@ An iterable of <code>DocObject</code> instances representing the module's public
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../project/">
|
<link rel="next" href="../project/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -890,7 +648,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -907,14 +665,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -1032,7 +790,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1049,14 +807,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1178,7 +936,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1195,14 +953,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1984,10 +1742,10 @@ An iterable of <code>DocObject</code> instances representing nested members.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../../nav/">
|
<link rel="next" href="../../nav/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -899,7 +657,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -916,14 +674,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -1041,7 +799,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1058,14 +816,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1187,7 +945,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1204,14 +962,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1942,10 +1700,10 @@ A list containing the dotted paths of all modules in the project.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="spec/">
|
<link rel="next" href="spec/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../wiki/" class="md-nav__link">
|
<a href=".." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link md-nav__link--active" for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link md-nav__link--active" for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -2514,10 +2272,10 @@ navigation pattern does not match any files.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../../renderers/">
|
<link rel="next" href="../../renderers/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -1005,7 +763,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1022,14 +780,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1151,7 +909,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1168,14 +926,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1635,10 +1393,10 @@ pages.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../mkdocs/">
|
<link rel="next" href="../mkdocs/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -1029,7 +787,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1046,14 +804,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1175,7 +933,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1192,14 +950,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1890,10 +1648,10 @@ navigation pattern does not match any files.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../resolver/">
|
<link rel="next" href="../resolver/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -1038,7 +796,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1055,14 +813,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1184,7 +942,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1201,14 +959,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -2006,10 +1764,10 @@ corresponding <code>NavSpec</code> instance.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
|
||||||
|
|
||||||
|
|
||||||
@@ -20,10 +20,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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -42,11 +42,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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>
|
||||||
@@ -205,7 +205,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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>
|
||||||
@@ -223,7 +223,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -241,248 +241,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -510,7 +268,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -527,14 +285,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -606,7 +364,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -623,14 +381,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -748,7 +506,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -765,14 +523,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -890,7 +648,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -907,14 +665,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1036,7 +794,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1053,14 +811,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1505,10 +1263,10 @@ The list is empty if the wiki contains no Markdown files.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
BIN
doc-forge/lib/objects.inv
Normal file
BIN
doc-forge/lib/objects.inv
Normal file
Binary file not shown.
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../mkdocs_renderer/">
|
<link rel="next" href="../mkdocs_renderer/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1184,7 +942,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1201,14 +959,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1802,10 +1560,10 @@ output directory used during rendering.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="base/">
|
<link rel="next" href="base/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../wiki/" class="md-nav__link">
|
<a href=".." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link md-nav__link--active" for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link md-nav__link--active" for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1040,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1057,14 +815,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1833,10 +1591,10 @@ rather than nesting it inside a folder.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../../cli/">
|
<link rel="next" href="../../cli/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1160,7 +918,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1177,14 +935,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1633,10 +1391,10 @@ supporting metadata files such as <code>nav.json</code> and <code>index.json</co
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
<link rel="next" href="../mcp_renderer/">
|
<link rel="next" href="../mcp_renderer/">
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<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,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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 +92,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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 +209,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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 +227,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -245,248 +245,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -514,7 +272,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -531,14 +289,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -610,7 +368,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -627,14 +385,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -752,7 +510,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -769,14 +527,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -894,7 +652,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" checked>
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -911,14 +669,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="true">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1169,7 +927,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1186,14 +944,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1792,10 +1550,10 @@ rather than nesting it inside a folder.</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
1
doc-forge/lib/search/search_index.json
Normal file
1
doc-forge/lib/search/search_index.json
Normal file
File diff suppressed because one or more lines are too long
@@ -11,7 +11,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
|
||||||
|
|
||||||
|
|
||||||
@@ -20,10 +20,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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -42,11 +42,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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>
|
||||||
@@ -205,7 +205,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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>
|
||||||
@@ -223,7 +223,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../wiki/" class="md-nav__link">
|
<a href=".." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -241,248 +241,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -510,7 +268,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -527,14 +285,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -606,7 +364,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -623,14 +381,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -748,7 +506,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -765,14 +523,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -890,7 +648,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -907,14 +665,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1036,7 +794,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1053,14 +811,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1587,10 +1345,10 @@ include <code>stdio</code>, <code>sse</code>, and <code>streamable-http</code>.<
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
|
||||||
|
|
||||||
|
|
||||||
@@ -20,10 +20,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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -42,11 +42,11 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@
|
|||||||
|
|
||||||
<header class="md-header md-header--shadow" 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">
|
<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>
|
<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>
|
||||||
@@ -205,7 +205,7 @@
|
|||||||
|
|
||||||
<nav class="md-nav md-nav--primary" 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">
|
<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>
|
<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>
|
||||||
@@ -223,7 +223,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="../../../wiki/" class="md-nav__link">
|
<a href="../.." class="md-nav__link">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -241,248 +241,6 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/01_overview/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Overview
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/02_architecture/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Architecture
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/03_conventions/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Conventions
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/04_iterative_workflow/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Iterative Workflow
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</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_6" >
|
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Development
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
</label>
|
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
||||||
<label class="md-nav__title" for="__nav_6">
|
|
||||||
<span class="md-nav__icon md-icon"></span>
|
|
||||||
Development
|
|
||||||
</label>
|
|
||||||
<ul class="md-nav__list" data-md-scrollfix>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/01_environment/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Environment
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/02_quality_gates/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Quality Gates
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/03_gsdfc_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Gsdfc Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<li class="md-nav__item">
|
|
||||||
<a href="../../../wiki/05_development/04_mcp_guide/" class="md-nav__link">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
|
||||||
Mcp Guide
|
|
||||||
|
|
||||||
</span>
|
|
||||||
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -510,7 +268,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -527,14 +285,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="">
|
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_7">
|
<label class="md-nav__title" for="__nav_2">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Loaders
|
Loaders
|
||||||
</label>
|
</label>
|
||||||
@@ -606,7 +364,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -623,14 +381,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="">
|
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_8">
|
<label class="md-nav__title" for="__nav_3">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Models
|
Models
|
||||||
</label>
|
</label>
|
||||||
@@ -748,7 +506,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -765,14 +523,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="">
|
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_9">
|
<label class="md-nav__title" for="__nav_4">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Navigation
|
Navigation
|
||||||
</label>
|
</label>
|
||||||
@@ -890,7 +648,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -907,14 +665,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_10" id="__nav_10_label" tabindex="">
|
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_10">
|
<label class="md-nav__title" for="__nav_5">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
Renderers
|
Renderers
|
||||||
</label>
|
</label>
|
||||||
@@ -1036,7 +794,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
|
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
|
||||||
|
|
||||||
|
|
||||||
<div class="md-nav__link md-nav__container">
|
<div class="md-nav__link md-nav__container">
|
||||||
@@ -1053,14 +811,14 @@
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
|
|
||||||
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="">
|
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
</label>
|
</label>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||||||
<label class="md-nav__title" for="__nav_11">
|
<label class="md-nav__title" for="__nav_6">
|
||||||
<span class="md-nav__icon md-icon"></span>
|
<span class="md-nav__icon md-icon"></span>
|
||||||
CLI
|
CLI
|
||||||
</label>
|
</label>
|
||||||
@@ -1597,10 +1355,10 @@ include <code>stdio</code>, <code>sse</code>, and <code>streamable-http</code>.<
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</body>
|
||||||
|
|||||||
Binary file not shown.
@@ -1,6 +0,0 @@
|
|||||||
{
|
|
||||||
"project": "docforge",
|
|
||||||
"type": "docforge-model",
|
|
||||||
"modules_count": 24,
|
|
||||||
"source": "docforge"
|
|
||||||
}
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.cli.api_utils",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.cli.api_utils",
|
|
||||||
"docstring": "# Summary\n\nUtilities for building API documentation from an OpenAPI specification.",
|
|
||||||
"objects": {
|
|
||||||
"json": {
|
|
||||||
"name": "json",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.json",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('json', 'json')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"dataclass": {
|
|
||||||
"name": "dataclass",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.dataclass",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('dataclass', 'dataclasses.dataclass')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"SWAGGER_SPEC_FILENAME": {
|
|
||||||
"name": "SWAGGER_SPEC_FILENAME",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.api_utils.SWAGGER_SPEC_FILENAME",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"OpenAPIMetadata": {
|
|
||||||
"name": "OpenAPIMetadata",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.api_utils.OpenAPIMetadata",
|
|
||||||
"signature": "<bound method Class.signature of Class('OpenAPIMetadata', 16, 30)>",
|
|
||||||
"docstring": "Metadata derived from the ``info`` block of an OpenAPI specification.\n\nAttributes:\n site_name: Spec title, used as the MkDocs site name.\n site_description: Spec description, used as the site description.\n site_author: Contact name (fallback: contact email), used as the\n site author.",
|
|
||||||
"members": {
|
|
||||||
"site_name": {
|
|
||||||
"name": "site_name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.api_utils.OpenAPIMetadata.site_name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"site_description": {
|
|
||||||
"name": "site_description",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.api_utils.OpenAPIMetadata.site_description",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"site_author": {
|
|
||||||
"name": "site_author",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.api_utils.OpenAPIMetadata.site_author",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"load_openapi_spec": {
|
|
||||||
"name": "load_openapi_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.api_utils.load_openapi_spec",
|
|
||||||
"signature": "<bound method Function.signature of Function('load_openapi_spec', 33, 64)>",
|
|
||||||
"docstring": "Load and validate an OpenAPI specification from a JSON file.\n\nArgs:\n spec_path (Path):\n Path to the OpenAPI JSON specification file.\n\nReturns:\n dict:\n The parsed OpenAPI specification.\n\nRaises:\n click.ClickException:\n If the file cannot be read or the ``info`` block is invalid."
|
|
||||||
},
|
|
||||||
"derive_metadata": {
|
|
||||||
"name": "derive_metadata",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.api_utils.derive_metadata",
|
|
||||||
"signature": "<bound method Function.signature of Function('derive_metadata', 67, 91)>",
|
|
||||||
"docstring": "Derive MkDocs site metadata from an OpenAPI spec ``info`` block.\n\nArgs:\n spec (dict):\n Parsed OpenAPI specification.\n\nReturns:\n OpenAPIMetadata:\n Site name, description, and author derived from the spec."
|
|
||||||
},
|
|
||||||
"generate_api_sources": {
|
|
||||||
"name": "generate_api_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.api_utils.generate_api_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_api_sources', 94, 118)>",
|
|
||||||
"docstring": "Generate swagger-enabled Markdown sources and the spec copy.\n\nThe specification is written as ``openapi.json`` inside ``docs_dir`` and\nan ``index.md`` embedding the swagger UI is generated alongside it.\n\nArgs:\n spec (dict):\n Parsed OpenAPI specification.\n docs_dir (Path):\n Directory (for example ``docs/api``) where the swagger\n sources are written."
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,551 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.cli.commands",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.cli.commands",
|
|
||||||
"docstring": "# Summary\n\nCommand definitions for the doc-forge CLI.\n\nProvides the CLI structure using Click, including build, serve, and tree commands.\n\n---\n\nNotes:\n - The `build` command validates requested modes before generating anything.\n - `--mkdocs`, `--api`, and `--wiki` share a single MkDocs build; `--mcp`\n generates a machine-readable bundle independently.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"api_utils": {
|
|
||||||
"name": "api_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.commands.api_utils",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('api_utils', 'docforge.cli.api_utils')>",
|
|
||||||
"docstring": "# Summary\n\nUtilities for building API documentation from an OpenAPI specification.",
|
|
||||||
"members": {
|
|
||||||
"json": {
|
|
||||||
"name": "json",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.json",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('json', 'docforge.cli.api_utils.json')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"dataclass": {
|
|
||||||
"name": "dataclass",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.dataclass",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('dataclass', 'docforge.cli.api_utils.dataclass')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'docforge.cli.api_utils.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'docforge.cli.api_utils.click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"SWAGGER_SPEC_FILENAME": {
|
|
||||||
"name": "SWAGGER_SPEC_FILENAME",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.api_utils.SWAGGER_SPEC_FILENAME",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('SWAGGER_SPEC_FILENAME', 'docforge.cli.api_utils.SWAGGER_SPEC_FILENAME')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"OpenAPIMetadata": {
|
|
||||||
"name": "OpenAPIMetadata",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.api_utils.OpenAPIMetadata",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('OpenAPIMetadata', 'docforge.cli.api_utils.OpenAPIMetadata')>",
|
|
||||||
"docstring": "Metadata derived from the ``info`` block of an OpenAPI specification.\n\nAttributes:\n site_name: Spec title, used as the MkDocs site name.\n site_description: Spec description, used as the site description.\n site_author: Contact name (fallback: contact email), used as the\n site author.",
|
|
||||||
"members": {
|
|
||||||
"site_name": {
|
|
||||||
"name": "site_name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.api_utils.OpenAPIMetadata.site_name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('site_name', 'docforge.cli.api_utils.OpenAPIMetadata.site_name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"site_description": {
|
|
||||||
"name": "site_description",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.api_utils.OpenAPIMetadata.site_description",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('site_description', 'docforge.cli.api_utils.OpenAPIMetadata.site_description')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"site_author": {
|
|
||||||
"name": "site_author",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.api_utils.OpenAPIMetadata.site_author",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('site_author', 'docforge.cli.api_utils.OpenAPIMetadata.site_author')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"load_openapi_spec": {
|
|
||||||
"name": "load_openapi_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.api_utils.load_openapi_spec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_openapi_spec', 'docforge.cli.api_utils.load_openapi_spec')>",
|
|
||||||
"docstring": "Load and validate an OpenAPI specification from a JSON file.\n\nArgs:\n spec_path (Path):\n Path to the OpenAPI JSON specification file.\n\nReturns:\n dict:\n The parsed OpenAPI specification.\n\nRaises:\n click.ClickException:\n If the file cannot be read or the ``info`` block is invalid."
|
|
||||||
},
|
|
||||||
"derive_metadata": {
|
|
||||||
"name": "derive_metadata",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.api_utils.derive_metadata",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('derive_metadata', 'docforge.cli.api_utils.derive_metadata')>",
|
|
||||||
"docstring": "Derive MkDocs site metadata from an OpenAPI spec ``info`` block.\n\nArgs:\n spec (dict):\n Parsed OpenAPI specification.\n\nReturns:\n OpenAPIMetadata:\n Site name, description, and author derived from the spec."
|
|
||||||
},
|
|
||||||
"generate_api_sources": {
|
|
||||||
"name": "generate_api_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.api_utils.generate_api_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_api_sources', 'docforge.cli.api_utils.generate_api_sources')>",
|
|
||||||
"docstring": "Generate swagger-enabled Markdown sources and the spec copy.\n\nThe specification is written as ``openapi.json`` inside ``docs_dir`` and\nan ``index.md`` embedding the swagger UI is generated alongside it.\n\nArgs:\n spec (dict):\n Parsed OpenAPI specification.\n docs_dir (Path):\n Directory (for example ``docs/api``) where the swagger\n sources are written."
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'docforge.cli.api_utils.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mcp_utils": {
|
|
||||||
"name": "mcp_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mcp_utils', 'docforge.cli.mcp_utils')>",
|
|
||||||
"docstring": "# Summary\n\nUtilities for working with MCP in the doc-forge CLI.\n\n---\n\nNotes:\n - `generate_resources` produces the bundle consumed by `MCPServer`:\n `index.json`, `nav.json`, and per-module resources under `modules/`.\n - Resource URIs use the `docs://` scheme: `docs://index`, `docs://nav`,\n and `docs://modules/{module}`.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'docforge.cli.mcp_utils.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'docforge.cli.mcp_utils.click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.cli.mcp_utils.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.cli.mcp_utils.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"MCPRenderer": {
|
|
||||||
"name": "MCPRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPRenderer', 'docforge.cli.mcp_utils.MCPRenderer')>",
|
|
||||||
"docstring": "Renderer that generates MCP-compatible documentation resources.\n\nThis renderer converts doc-forge project models into structured JSON\nresources suitable for consumption by systems implementing the Model\nContext Protocol (MCP).",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mcp_renderer.MCPRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mcp_renderer.MCPRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate MCP documentation resources for a project.\n\nThe renderer serializes each module into a JSON resource and produces\nsupporting metadata files such as `nav.json` and `index.json`.\n\nArgs:\n project (Project):\n Documentation project model to render.\n\n out_dir (Path):\n Directory where MCP resources will be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MCPServer": {
|
|
||||||
"name": "MCPServer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPServer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPServer', 'docforge.cli.mcp_utils.MCPServer')>",
|
|
||||||
"docstring": "MCP server for serving a pre-generated documentation bundle.\n\nThe server exposes documentation resources and diagnostic tools through\nMCP endpoints backed by JSON files generated by the MCP renderer.\n\nAttributes:\n mcp_root (Path):\n Directory containing the generated MCP documentation bundle.\n\n app (FastMCP):\n Underlying FastMCP application instance that registers resources\n and tools.",
|
|
||||||
"members": {
|
|
||||||
"mcp_root": {
|
|
||||||
"name": "mcp_root",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPServer.mcp_root",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mcp_root', 'docforge.servers.mcp_server.MCPServer.mcp_root')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"app": {
|
|
||||||
"name": "app",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPServer.app",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('app', 'docforge.servers.mcp_server.MCPServer.app')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"run": {
|
|
||||||
"name": "run",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPServer.run",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('run', 'docforge.servers.mcp_server.MCPServer.run')>",
|
|
||||||
"docstring": "Start the MCP server.\n\nArgs:\n transport (Literal[\"stdio\", \"sse\", \"streamable-http\"]):\n Transport mechanism used by the MCP server. Supported options\n include `stdio`, `sse`, and `streamable-http`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"generate_resources": {
|
|
||||||
"name": "generate_resources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.generate_resources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_resources', 'docforge.cli.mcp_utils.generate_resources')>",
|
|
||||||
"docstring": "Generate MCP documentation resources from a Python module.\n\nThe function performs project introspection, builds the internal\ndocumentation model, and renders MCP-compatible JSON resources\nto the specified output directory.\n\nArgs:\n module (str):\n Python module import path used as the entry point for\n documentation generation.\n\n project_name (str | None):\n Optional override for the project name used in generated\n documentation metadata.\n\n out_dir (Path):\n Directory where MCP resources (index.json, nav.json, and module data)\n will be written."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.serve",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('serve', 'docforge.cli.mcp_utils.serve')>",
|
|
||||||
"docstring": "Start an MCP server for a pre-generated documentation bundle.\n\nThe server exposes documentation resources such as project metadata,\nnavigation structure, and module documentation through MCP endpoints.\n\nArgs:\n module (str):\n Python module import path used to identify the served\n documentation instance.\n\n mcp_root (Path):\n Path to the directory containing the MCP documentation\n bundle (index.json, nav.json, and modules/).\n\nRaises:\n click.ClickException:\n If the MCP documentation bundle is missing required files or directories."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mkdocs_utils": {
|
|
||||||
"name": "mkdocs_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mkdocs_utils', 'docforge.cli.mkdocs_utils')>",
|
|
||||||
"docstring": "# Summary\n\nUtilities for working with MkDocs in the doc-forge CLI.\n\n---\n\nNotes:\n - A single generated `mkdocs.yml` serves lib, api, and wiki content with\n merged navigation. Wiki navigation, when enabled, precedes every other\n group and its `index.md` becomes the site `Home`.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"os": {
|
|
||||||
"name": "os",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.os",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('os', 'docforge.cli.mkdocs_utils.os')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'docforge.cli.mkdocs_utils.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"resources": {
|
|
||||||
"name": "resources",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.resources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resources', 'docforge.cli.mkdocs_utils.resources')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'docforge.cli.mkdocs_utils.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'docforge.cli.mkdocs_utils.click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"yaml": {
|
|
||||||
"name": "yaml",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.yaml",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('yaml', 'docforge.cli.mkdocs_utils.yaml')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.cli.mkdocs_utils.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.cli.mkdocs_utils.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"MkDocsNavEmitter": {
|
|
||||||
"name": "MkDocsNavEmitter",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsNavEmitter",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsNavEmitter', 'docforge.cli.mkdocs_utils.MkDocsNavEmitter')>",
|
|
||||||
"docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
|
|
||||||
"members": {
|
|
||||||
"emit": {
|
|
||||||
"name": "emit",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsNavEmitter.emit",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('emit', 'docforge.nav.mkdocs.MkDocsNavEmitter.emit')>",
|
|
||||||
"docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n nav (ResolvedNav):\n Resolved navigation data describing documentation groups\n and their associated Markdown files.\n\nReturns:\n list[dict[str, Any]]:\n A list of dictionaries representing the MkDocs navigation layout.\n Each dictionary maps a navigation label to a page or a list of\n pages."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"build_wiki_nav": {
|
|
||||||
"name": "build_wiki_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.build_wiki_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('build_wiki_nav', 'docforge.cli.mkdocs_utils.build_wiki_nav')>",
|
|
||||||
"docstring": "Derive an MkDocs navigation block from a wiki directory.\n\nReturned paths are relative to the parent of ``wiki_dir`` and carry the\nwiki directory name as their leading component (for example\n``wiki/01_overview.md`` when the wiki lives at ``docs/wiki``). This makes\nthe result directly usable in an MkDocs ``nav`` block with\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.\n\nArgs:\n wiki_dir (Path):\n Path to the hand-written wiki directory, for example ``docs/wiki``.\n\nReturns:\n list[dict[str, Any]]:\n Navigation entries compatible with the MkDocs ``nav`` configuration.\n The list is empty if the wiki contains no Markdown files.\n\nRaises:\n FileNotFoundError:\n If the wiki directory does not exist."
|
|
||||||
},
|
|
||||||
"load_nav_spec": {
|
|
||||||
"name": "load_nav_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.load_nav_spec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_nav_spec', 'docforge.cli.mkdocs_utils.load_nav_spec')>",
|
|
||||||
"docstring": "Load a navigation specification file.\n\nThis helper function reads a YAML navigation file and constructs a\ncorresponding ``NavSpec`` instance.\n\nArgs:\n path (Path):\n Path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed specification.\n\nRaises:\n FileNotFoundError: If the specification file does not exist.\n ValueError: If the YAML structure is invalid."
|
|
||||||
},
|
|
||||||
"resolve_nav": {
|
|
||||||
"name": "resolve_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.resolve_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resolve_nav', 'docforge.cli.mkdocs_utils.resolve_nav')>",
|
|
||||||
"docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n spec (NavSpec):\n Navigation specification describing documentation layout.\n docs_root (Path):\n Root directory containing documentation Markdown files.\n\nReturns:\n ResolvedNav:\n A `ResolvedNav` instance containing validated navigation paths.\n\nRaises:\n FileNotFoundError: If the documentation root does not exist or a\n navigation pattern does not match any files."
|
|
||||||
},
|
|
||||||
"MkDocsRenderer": {
|
|
||||||
"name": "MkDocsRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsRenderer', 'docforge.cli.mkdocs_utils.MkDocsRenderer')>",
|
|
||||||
"docstring": "Renderer that produces Markdown documentation for MkDocs.\n\nGenerated pages use mkdocstrings directives to reference Python modules,\nallowing MkDocs to render API documentation dynamically.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate Markdown documentation files for a project.\n\nThis method renders a documentation structure from the provided\nproject model and writes the resulting Markdown files to the\nspecified output directory.\n\nArgs:\n project (Project):\n Project model containing modules to document.\n\n out_dir (Path):\n Directory where generated Markdown files will be written.\n\n module_is_source (bool | None):\n If True, treat the specified module as the documentation root\n rather than nesting it inside a folder."
|
|
||||||
},
|
|
||||||
"generate_readme": {
|
|
||||||
"name": "generate_readme",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer.generate_readme",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_readme', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme')>",
|
|
||||||
"docstring": "Generate a `README.md` file from the root module docstring.\n\nNotes:\n - If `module_is_source` is True, `README.md` is written to the\n project root directory.\n - If False, README generation is currently not implemented.\n\nArgs:\n project (Project):\n Project model containing documentation metadata.\n\n docs_dir (Path):\n Directory containing generated documentation sources.\n\n module_is_source (bool | None):\n Whether the module is treated as the project source root.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written.\n Defaults to the parent of `docs_dir`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.cli.mkdocs_utils.generate_sources')>",
|
|
||||||
"docstring": "Generate MkDocs Markdown sources for a Python module.\n\nThis function introspects the specified module, builds the internal\ndocumentation model, and renders Markdown documentation files for\nuse with MkDocs.\n\nArgs:\n module (str):\n Python module import path used as the entry point for\n documentation generation.\n\n docs_dir (Path):\n Directory where the generated Markdown files will be written.\n\n project_name (str | None):\n Optional override for the project name used in documentation metadata.\n\n module_is_source (bool | None):\n If True, treat the specified module directory as the project root\n rather than a nested module.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written. If not\n provided, defaults to the parent of ``docs_dir``."
|
|
||||||
},
|
|
||||||
"generate_config": {
|
|
||||||
"name": "generate_config",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.generate_config",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_config', 'docforge.cli.mkdocs_utils.generate_config')>",
|
|
||||||
"docstring": "Generate an `mkdocs.yml` configuration file.\n\nThe configuration is created by combining a template configuration\nwith a navigation structure derived from the docforge navigation\nspecification (and, when a wiki directory is provided, from the wiki\nfile structure).\n\nThe ``docs_dir`` is always written relative to the MkDocs root and is\nexpected to be the shared documentation parent (for example ``docs``),\nwith generated sources nested under ``lib/`` or ``api/`` subdirectories\nand hand-written wiki content under a ``wiki/`` subdirectory.\n\nArgs:\n docs_dir (Path):\n Shared documentation root used as the MkDocs ``docs_dir``.\n\n nav_file (Path):\n Path to the `docforge.nav.yml` navigation specification.\n\n template (Path | None):\n Optional path to a fully custom MkDocs configuration template.\n If not provided, built-in templates are merged; the provided\n template replaces the built-in templates entirely.\n\n out (Path):\n Destination path where the generated `mkdocs.yml` file will be written.\n\n site_name (str):\n Display name for the generated documentation site.\n\n modes (Iterable[str] | None):\n Documentation modes to enable. Each mode contributes its own\n built-in template fragment (for example ``lib``, ``api``, or\n ``wiki``), merged on top of the shared ``mkdocs.common.yml``\n template.\n\n site_description (str | None):\n Optional site description written into the configuration.\n\n site_author (str | None):\n Optional site author written into the configuration.\n\n wiki_dir (Path | None):\n Optional path to a hand-written wiki directory (for example\n ``docs/wiki``). When provided, the site navigation is derived\n from the wiki file structure and placed before the navigation\n groups defined in ``nav_file``.\n\nRaises:\n click.FileError:\n If the navigation specification, template, or wiki directory\n cannot be found."
|
|
||||||
},
|
|
||||||
"build": {
|
|
||||||
"name": "build",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.build",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('build', 'docforge.cli.mkdocs_utils.build')>",
|
|
||||||
"docstring": "Build the MkDocs documentation site.\n\nThis function loads the MkDocs configuration and runs the MkDocs\nbuild command to generate the final static documentation site.\n\nArgs:\n mkdocs_yml (Path):\n Path to the `mkdocs.yml` configuration file.\n\nRaises:\n click.ClickException:\n If the configuration file does not exist."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.serve",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('serve', 'docforge.cli.mkdocs_utils.serve')>",
|
|
||||||
"docstring": "Start an MkDocs development server with live reload.\n\nThe server watches documentation files and automatically reloads\nthe site when changes are detected.\n\nArgs:\n mkdocs_yml (Path):\n Path to the `mkdocs.yml` configuration file.\n\nRaises:\n click.ClickException:\n If the configuration file does not exist."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.loaders.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"cli": {
|
|
||||||
"name": "cli",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.cli",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"build": {
|
|
||||||
"name": "build",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.build",
|
|
||||||
"signature": "<bound method Function.signature of Function('build', 38, 260)>",
|
|
||||||
"docstring": "Build documentation artifacts.\n\nThis command runs the full documentation pipeline: it loads Python\nmodules, generates renderer-specific documentation sources, and\noptionally builds or serves the final output.\n\nDepending on the selected options, the build can target:\n\n- MkDocs static documentation sites for library reference docs\n- Swagger-enabled API docs generated from an OpenAPI spec\n- Hand-written wiki pages included in the MkDocs site\n- MCP structured documentation resources\n\nNotes:\n - At least one of `--mcp`, `--mkdocs`, `--wiki`, or `--api` must be\n provided.\n - `--mkdocs`, `--api`, and `--wiki` are combined into a single MkDocs\n build, while `--mcp` emits a machine-readable bundle.\n\nArgs:\n mcp (bool):\n Enable MCP documentation generation.\n\n mkdocs (bool):\n Enable MkDocs library documentation generation.\n\n api (bool):\n Enable API documentation generation from an OpenAPI spec.\n\n wiki (bool):\n Include a hand-written wiki directory in the MkDocs site.\n\n module_is_source (bool):\n Treat the specified module directory as the project root.\n\n module (str | None):\n Python module import path to document.\n\n openapi_spec (Path | None):\n Path to the OpenAPI JSON specification used for API docs.\n\n project_name (str | None):\n Optional override for the project name.\n\n site_name (str | None):\n Display name for the MkDocs site.\n\n docs_dir (Path):\n Shared documentation root used as the MkDocs ``docs_dir``.\n\n wiki_dir (Path):\n Directory containing hand-written wiki markdown files.\n\n nav_file (Path):\n Path to the navigation specification file.\n\n template (Path | None):\n Optional custom MkDocs configuration template.\n\n mkdocs_yml (Path):\n Output path for the generated MkDocs configuration.\n\n out_dir (Path):\n Output directory for generated MCP resources.\n\nRaises:\n click.UsageError:\n If required options are missing or conflicting."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.serve",
|
|
||||||
"signature": "<bound method Function.signature of Function('serve', 263, 324)>",
|
|
||||||
"docstring": "Serve generated documentation locally.\n\nDepending on the selected mode, this command starts either:\n\n- A MkDocs development server for browsing documentation\n- An MCP server exposing structured documentation resources\n\nArgs:\n mcp (bool):\n Serve documentation using the MCP server.\n\n mkdocs (bool):\n Serve the MkDocs development site.\n\n module (str | None):\n Python module import path to serve via MCP.\n\n mkdocs_yml (Path):\n Path to the MkDocs configuration file.\n\n out_dir (Path):\n Root directory containing MCP documentation resources.\n\nRaises:\n click.UsageError:\n If invalid or conflicting options are provided."
|
|
||||||
},
|
|
||||||
"tree": {
|
|
||||||
"name": "tree",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.tree",
|
|
||||||
"signature": "<bound method Function.signature of Function('tree', 327, 363)>",
|
|
||||||
"docstring": "Display the documentation object tree for a module.\n\nThis command introspects the specified module and prints a\nhierarchical representation of the discovered documentation\nobjects, including modules, classes, functions, and members.\n\nArgs:\n module (str):\n Python module import path to introspect.\n\n project_name (str | None):\n Optional name to display as the project root."
|
|
||||||
},
|
|
||||||
"Group": {
|
|
||||||
"name": "Group",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.Group",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Group', 'click.core.Group')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,981 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.cli",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.cli",
|
|
||||||
"docstring": "# Summary\n\nCommand line interface entry point for doc-forge.\n\nThis module exposes the primary CLI entry function used by the\n`doc-forge` command. The actual command implementation resides in\n`docforge.cli.main`, while this module provides a stable import path\nfor external tools and the package entry point configuration.\n\nThe CLI is responsible for orchestrating documentation workflows such as\ngenerating renderer sources, building documentation sites, exporting\nmachine-readable documentation bundles, and starting development or MCP\nservers.\n\n---\n\n# Typical usage\n\nThe CLI is normally invoked through the installed command:\n\n```bash\ndoc-forge <command> [options]\n```\n\nProgrammatic invocation is also possible:\n\nExample:\n\n ```python\n from docforge.cli import main\n main()\n ```\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"main": {
|
|
||||||
"name": "main",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.main",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nCommand-line entry point for the doc-forge CLI.\n\nThis module exposes the executable entry point that initializes the\nClick command group defined in `docforge.cli.commands`.",
|
|
||||||
"members": {
|
|
||||||
"cli": {
|
|
||||||
"name": "cli",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.main.cli",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('cli', 'docforge.cli.commands.cli')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"main": {
|
|
||||||
"name": "main",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.main.main",
|
|
||||||
"signature": "<bound method Function.signature of Function('main', 13, 21)>",
|
|
||||||
"docstring": "Run the doc-forge command-line interface.\n\nThis function initializes and executes the Click CLI application.\nIt is used as the console entry point when invoking `doc-forge`\nfrom the command line."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"api_utils": {
|
|
||||||
"name": "api_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.api_utils",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nUtilities for building API documentation from an OpenAPI specification.",
|
|
||||||
"members": {
|
|
||||||
"json": {
|
|
||||||
"name": "json",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.json",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('json', 'json')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"dataclass": {
|
|
||||||
"name": "dataclass",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.dataclass",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('dataclass', 'dataclasses.dataclass')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"SWAGGER_SPEC_FILENAME": {
|
|
||||||
"name": "SWAGGER_SPEC_FILENAME",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.api_utils.SWAGGER_SPEC_FILENAME",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"OpenAPIMetadata": {
|
|
||||||
"name": "OpenAPIMetadata",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.api_utils.OpenAPIMetadata",
|
|
||||||
"signature": "<bound method Class.signature of Class('OpenAPIMetadata', 16, 30)>",
|
|
||||||
"docstring": "Metadata derived from the ``info`` block of an OpenAPI specification.\n\nAttributes:\n site_name: Spec title, used as the MkDocs site name.\n site_description: Spec description, used as the site description.\n site_author: Contact name (fallback: contact email), used as the\n site author.",
|
|
||||||
"members": {
|
|
||||||
"site_name": {
|
|
||||||
"name": "site_name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.api_utils.OpenAPIMetadata.site_name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"site_description": {
|
|
||||||
"name": "site_description",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.api_utils.OpenAPIMetadata.site_description",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"site_author": {
|
|
||||||
"name": "site_author",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.api_utils.OpenAPIMetadata.site_author",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"load_openapi_spec": {
|
|
||||||
"name": "load_openapi_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.api_utils.load_openapi_spec",
|
|
||||||
"signature": "<bound method Function.signature of Function('load_openapi_spec', 33, 64)>",
|
|
||||||
"docstring": "Load and validate an OpenAPI specification from a JSON file.\n\nArgs:\n spec_path (Path):\n Path to the OpenAPI JSON specification file.\n\nReturns:\n dict:\n The parsed OpenAPI specification.\n\nRaises:\n click.ClickException:\n If the file cannot be read or the ``info`` block is invalid."
|
|
||||||
},
|
|
||||||
"derive_metadata": {
|
|
||||||
"name": "derive_metadata",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.api_utils.derive_metadata",
|
|
||||||
"signature": "<bound method Function.signature of Function('derive_metadata', 67, 91)>",
|
|
||||||
"docstring": "Derive MkDocs site metadata from an OpenAPI spec ``info`` block.\n\nArgs:\n spec (dict):\n Parsed OpenAPI specification.\n\nReturns:\n OpenAPIMetadata:\n Site name, description, and author derived from the spec."
|
|
||||||
},
|
|
||||||
"generate_api_sources": {
|
|
||||||
"name": "generate_api_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.api_utils.generate_api_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_api_sources', 94, 118)>",
|
|
||||||
"docstring": "Generate swagger-enabled Markdown sources and the spec copy.\n\nThe specification is written as ``openapi.json`` inside ``docs_dir`` and\nan ``index.md`` embedding the swagger UI is generated alongside it.\n\nArgs:\n spec (dict):\n Parsed OpenAPI specification.\n docs_dir (Path):\n Directory (for example ``docs/api``) where the swagger\n sources are written."
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.api_utils.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"commands": {
|
|
||||||
"name": "commands",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.commands",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nCommand definitions for the doc-forge CLI.\n\nProvides the CLI structure using Click, including build, serve, and tree commands.\n\n---\n\nNotes:\n - The `build` command validates requested modes before generating anything.\n - `--mkdocs`, `--api`, and `--wiki` share a single MkDocs build; `--mcp`\n generates a machine-readable bundle independently.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"api_utils": {
|
|
||||||
"name": "api_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.commands.api_utils",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('api_utils', 'docforge.cli.api_utils')>",
|
|
||||||
"docstring": "# Summary\n\nUtilities for building API documentation from an OpenAPI specification.",
|
|
||||||
"members": {
|
|
||||||
"json": {
|
|
||||||
"name": "json",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.json",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('json', 'docforge.cli.api_utils.json')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"dataclass": {
|
|
||||||
"name": "dataclass",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.dataclass",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('dataclass', 'docforge.cli.api_utils.dataclass')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'docforge.cli.api_utils.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'docforge.cli.api_utils.click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"SWAGGER_SPEC_FILENAME": {
|
|
||||||
"name": "SWAGGER_SPEC_FILENAME",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.api_utils.SWAGGER_SPEC_FILENAME",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('SWAGGER_SPEC_FILENAME', 'docforge.cli.api_utils.SWAGGER_SPEC_FILENAME')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"OpenAPIMetadata": {
|
|
||||||
"name": "OpenAPIMetadata",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.api_utils.OpenAPIMetadata",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('OpenAPIMetadata', 'docforge.cli.api_utils.OpenAPIMetadata')>",
|
|
||||||
"docstring": "Metadata derived from the ``info`` block of an OpenAPI specification.\n\nAttributes:\n site_name: Spec title, used as the MkDocs site name.\n site_description: Spec description, used as the site description.\n site_author: Contact name (fallback: contact email), used as the\n site author.",
|
|
||||||
"members": {
|
|
||||||
"site_name": {
|
|
||||||
"name": "site_name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.api_utils.OpenAPIMetadata.site_name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('site_name', 'docforge.cli.api_utils.OpenAPIMetadata.site_name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"site_description": {
|
|
||||||
"name": "site_description",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.api_utils.OpenAPIMetadata.site_description",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('site_description', 'docforge.cli.api_utils.OpenAPIMetadata.site_description')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"site_author": {
|
|
||||||
"name": "site_author",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.api_utils.OpenAPIMetadata.site_author",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('site_author', 'docforge.cli.api_utils.OpenAPIMetadata.site_author')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"load_openapi_spec": {
|
|
||||||
"name": "load_openapi_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.api_utils.load_openapi_spec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_openapi_spec', 'docforge.cli.api_utils.load_openapi_spec')>",
|
|
||||||
"docstring": "Load and validate an OpenAPI specification from a JSON file.\n\nArgs:\n spec_path (Path):\n Path to the OpenAPI JSON specification file.\n\nReturns:\n dict:\n The parsed OpenAPI specification.\n\nRaises:\n click.ClickException:\n If the file cannot be read or the ``info`` block is invalid."
|
|
||||||
},
|
|
||||||
"derive_metadata": {
|
|
||||||
"name": "derive_metadata",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.api_utils.derive_metadata",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('derive_metadata', 'docforge.cli.api_utils.derive_metadata')>",
|
|
||||||
"docstring": "Derive MkDocs site metadata from an OpenAPI spec ``info`` block.\n\nArgs:\n spec (dict):\n Parsed OpenAPI specification.\n\nReturns:\n OpenAPIMetadata:\n Site name, description, and author derived from the spec."
|
|
||||||
},
|
|
||||||
"generate_api_sources": {
|
|
||||||
"name": "generate_api_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.api_utils.generate_api_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_api_sources', 'docforge.cli.api_utils.generate_api_sources')>",
|
|
||||||
"docstring": "Generate swagger-enabled Markdown sources and the spec copy.\n\nThe specification is written as ``openapi.json`` inside ``docs_dir`` and\nan ``index.md`` embedding the swagger UI is generated alongside it.\n\nArgs:\n spec (dict):\n Parsed OpenAPI specification.\n docs_dir (Path):\n Directory (for example ``docs/api``) where the swagger\n sources are written."
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.api_utils.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'docforge.cli.api_utils.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mcp_utils": {
|
|
||||||
"name": "mcp_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mcp_utils', 'docforge.cli.mcp_utils')>",
|
|
||||||
"docstring": "# Summary\n\nUtilities for working with MCP in the doc-forge CLI.\n\n---\n\nNotes:\n - `generate_resources` produces the bundle consumed by `MCPServer`:\n `index.json`, `nav.json`, and per-module resources under `modules/`.\n - Resource URIs use the `docs://` scheme: `docs://index`, `docs://nav`,\n and `docs://modules/{module}`.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'docforge.cli.mcp_utils.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'docforge.cli.mcp_utils.click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.cli.mcp_utils.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.cli.mcp_utils.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"MCPRenderer": {
|
|
||||||
"name": "MCPRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPRenderer', 'docforge.cli.mcp_utils.MCPRenderer')>",
|
|
||||||
"docstring": "Renderer that generates MCP-compatible documentation resources.\n\nThis renderer converts doc-forge project models into structured JSON\nresources suitable for consumption by systems implementing the Model\nContext Protocol (MCP).",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mcp_renderer.MCPRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mcp_renderer.MCPRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate MCP documentation resources for a project.\n\nThe renderer serializes each module into a JSON resource and produces\nsupporting metadata files such as `nav.json` and `index.json`.\n\nArgs:\n project (Project):\n Documentation project model to render.\n\n out_dir (Path):\n Directory where MCP resources will be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MCPServer": {
|
|
||||||
"name": "MCPServer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPServer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPServer', 'docforge.cli.mcp_utils.MCPServer')>",
|
|
||||||
"docstring": "MCP server for serving a pre-generated documentation bundle.\n\nThe server exposes documentation resources and diagnostic tools through\nMCP endpoints backed by JSON files generated by the MCP renderer.\n\nAttributes:\n mcp_root (Path):\n Directory containing the generated MCP documentation bundle.\n\n app (FastMCP):\n Underlying FastMCP application instance that registers resources\n and tools.",
|
|
||||||
"members": {
|
|
||||||
"mcp_root": {
|
|
||||||
"name": "mcp_root",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPServer.mcp_root",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mcp_root', 'docforge.servers.mcp_server.MCPServer.mcp_root')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"app": {
|
|
||||||
"name": "app",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPServer.app",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('app', 'docforge.servers.mcp_server.MCPServer.app')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"run": {
|
|
||||||
"name": "run",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.MCPServer.run",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('run', 'docforge.servers.mcp_server.MCPServer.run')>",
|
|
||||||
"docstring": "Start the MCP server.\n\nArgs:\n transport (Literal[\"stdio\", \"sse\", \"streamable-http\"]):\n Transport mechanism used by the MCP server. Supported options\n include `stdio`, `sse`, and `streamable-http`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"generate_resources": {
|
|
||||||
"name": "generate_resources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.generate_resources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_resources', 'docforge.cli.mcp_utils.generate_resources')>",
|
|
||||||
"docstring": "Generate MCP documentation resources from a Python module.\n\nThe function performs project introspection, builds the internal\ndocumentation model, and renders MCP-compatible JSON resources\nto the specified output directory.\n\nArgs:\n module (str):\n Python module import path used as the entry point for\n documentation generation.\n\n project_name (str | None):\n Optional override for the project name used in generated\n documentation metadata.\n\n out_dir (Path):\n Directory where MCP resources (index.json, nav.json, and module data)\n will be written."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mcp_utils.serve",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('serve', 'docforge.cli.mcp_utils.serve')>",
|
|
||||||
"docstring": "Start an MCP server for a pre-generated documentation bundle.\n\nThe server exposes documentation resources such as project metadata,\nnavigation structure, and module documentation through MCP endpoints.\n\nArgs:\n module (str):\n Python module import path used to identify the served\n documentation instance.\n\n mcp_root (Path):\n Path to the directory containing the MCP documentation\n bundle (index.json, nav.json, and modules/).\n\nRaises:\n click.ClickException:\n If the MCP documentation bundle is missing required files or directories."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mkdocs_utils": {
|
|
||||||
"name": "mkdocs_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mkdocs_utils', 'docforge.cli.mkdocs_utils')>",
|
|
||||||
"docstring": "# Summary\n\nUtilities for working with MkDocs in the doc-forge CLI.\n\n---\n\nNotes:\n - A single generated `mkdocs.yml` serves lib, api, and wiki content with\n merged navigation. Wiki navigation, when enabled, precedes every other\n group and its `index.md` becomes the site `Home`.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"os": {
|
|
||||||
"name": "os",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.os",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('os', 'docforge.cli.mkdocs_utils.os')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'docforge.cli.mkdocs_utils.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"resources": {
|
|
||||||
"name": "resources",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.resources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resources', 'docforge.cli.mkdocs_utils.resources')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'docforge.cli.mkdocs_utils.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'docforge.cli.mkdocs_utils.click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"yaml": {
|
|
||||||
"name": "yaml",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.yaml",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('yaml', 'docforge.cli.mkdocs_utils.yaml')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.cli.mkdocs_utils.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.cli.mkdocs_utils.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"MkDocsNavEmitter": {
|
|
||||||
"name": "MkDocsNavEmitter",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsNavEmitter",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsNavEmitter', 'docforge.cli.mkdocs_utils.MkDocsNavEmitter')>",
|
|
||||||
"docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
|
|
||||||
"members": {
|
|
||||||
"emit": {
|
|
||||||
"name": "emit",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsNavEmitter.emit",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('emit', 'docforge.nav.mkdocs.MkDocsNavEmitter.emit')>",
|
|
||||||
"docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n nav (ResolvedNav):\n Resolved navigation data describing documentation groups\n and their associated Markdown files.\n\nReturns:\n list[dict[str, Any]]:\n A list of dictionaries representing the MkDocs navigation layout.\n Each dictionary maps a navigation label to a page or a list of\n pages."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"build_wiki_nav": {
|
|
||||||
"name": "build_wiki_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.build_wiki_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('build_wiki_nav', 'docforge.cli.mkdocs_utils.build_wiki_nav')>",
|
|
||||||
"docstring": "Derive an MkDocs navigation block from a wiki directory.\n\nReturned paths are relative to the parent of ``wiki_dir`` and carry the\nwiki directory name as their leading component (for example\n``wiki/01_overview.md`` when the wiki lives at ``docs/wiki``). This makes\nthe result directly usable in an MkDocs ``nav`` block with\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.\n\nArgs:\n wiki_dir (Path):\n Path to the hand-written wiki directory, for example ``docs/wiki``.\n\nReturns:\n list[dict[str, Any]]:\n Navigation entries compatible with the MkDocs ``nav`` configuration.\n The list is empty if the wiki contains no Markdown files.\n\nRaises:\n FileNotFoundError:\n If the wiki directory does not exist."
|
|
||||||
},
|
|
||||||
"load_nav_spec": {
|
|
||||||
"name": "load_nav_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.load_nav_spec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_nav_spec', 'docforge.cli.mkdocs_utils.load_nav_spec')>",
|
|
||||||
"docstring": "Load a navigation specification file.\n\nThis helper function reads a YAML navigation file and constructs a\ncorresponding ``NavSpec`` instance.\n\nArgs:\n path (Path):\n Path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed specification.\n\nRaises:\n FileNotFoundError: If the specification file does not exist.\n ValueError: If the YAML structure is invalid."
|
|
||||||
},
|
|
||||||
"resolve_nav": {
|
|
||||||
"name": "resolve_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.resolve_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resolve_nav', 'docforge.cli.mkdocs_utils.resolve_nav')>",
|
|
||||||
"docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n spec (NavSpec):\n Navigation specification describing documentation layout.\n docs_root (Path):\n Root directory containing documentation Markdown files.\n\nReturns:\n ResolvedNav:\n A `ResolvedNav` instance containing validated navigation paths.\n\nRaises:\n FileNotFoundError: If the documentation root does not exist or a\n navigation pattern does not match any files."
|
|
||||||
},
|
|
||||||
"MkDocsRenderer": {
|
|
||||||
"name": "MkDocsRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsRenderer', 'docforge.cli.mkdocs_utils.MkDocsRenderer')>",
|
|
||||||
"docstring": "Renderer that produces Markdown documentation for MkDocs.\n\nGenerated pages use mkdocstrings directives to reference Python modules,\nallowing MkDocs to render API documentation dynamically.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate Markdown documentation files for a project.\n\nThis method renders a documentation structure from the provided\nproject model and writes the resulting Markdown files to the\nspecified output directory.\n\nArgs:\n project (Project):\n Project model containing modules to document.\n\n out_dir (Path):\n Directory where generated Markdown files will be written.\n\n module_is_source (bool | None):\n If True, treat the specified module as the documentation root\n rather than nesting it inside a folder."
|
|
||||||
},
|
|
||||||
"generate_readme": {
|
|
||||||
"name": "generate_readme",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.MkDocsRenderer.generate_readme",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_readme', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme')>",
|
|
||||||
"docstring": "Generate a `README.md` file from the root module docstring.\n\nNotes:\n - If `module_is_source` is True, `README.md` is written to the\n project root directory.\n - If False, README generation is currently not implemented.\n\nArgs:\n project (Project):\n Project model containing documentation metadata.\n\n docs_dir (Path):\n Directory containing generated documentation sources.\n\n module_is_source (bool | None):\n Whether the module is treated as the project source root.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written.\n Defaults to the parent of `docs_dir`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.cli.mkdocs_utils.generate_sources')>",
|
|
||||||
"docstring": "Generate MkDocs Markdown sources for a Python module.\n\nThis function introspects the specified module, builds the internal\ndocumentation model, and renders Markdown documentation files for\nuse with MkDocs.\n\nArgs:\n module (str):\n Python module import path used as the entry point for\n documentation generation.\n\n docs_dir (Path):\n Directory where the generated Markdown files will be written.\n\n project_name (str | None):\n Optional override for the project name used in documentation metadata.\n\n module_is_source (bool | None):\n If True, treat the specified module directory as the project root\n rather than a nested module.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written. If not\n provided, defaults to the parent of ``docs_dir``."
|
|
||||||
},
|
|
||||||
"generate_config": {
|
|
||||||
"name": "generate_config",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.generate_config",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_config', 'docforge.cli.mkdocs_utils.generate_config')>",
|
|
||||||
"docstring": "Generate an `mkdocs.yml` configuration file.\n\nThe configuration is created by combining a template configuration\nwith a navigation structure derived from the docforge navigation\nspecification (and, when a wiki directory is provided, from the wiki\nfile structure).\n\nThe ``docs_dir`` is always written relative to the MkDocs root and is\nexpected to be the shared documentation parent (for example ``docs``),\nwith generated sources nested under ``lib/`` or ``api/`` subdirectories\nand hand-written wiki content under a ``wiki/`` subdirectory.\n\nArgs:\n docs_dir (Path):\n Shared documentation root used as the MkDocs ``docs_dir``.\n\n nav_file (Path):\n Path to the `docforge.nav.yml` navigation specification.\n\n template (Path | None):\n Optional path to a fully custom MkDocs configuration template.\n If not provided, built-in templates are merged; the provided\n template replaces the built-in templates entirely.\n\n out (Path):\n Destination path where the generated `mkdocs.yml` file will be written.\n\n site_name (str):\n Display name for the generated documentation site.\n\n modes (Iterable[str] | None):\n Documentation modes to enable. Each mode contributes its own\n built-in template fragment (for example ``lib``, ``api``, or\n ``wiki``), merged on top of the shared ``mkdocs.common.yml``\n template.\n\n site_description (str | None):\n Optional site description written into the configuration.\n\n site_author (str | None):\n Optional site author written into the configuration.\n\n wiki_dir (Path | None):\n Optional path to a hand-written wiki directory (for example\n ``docs/wiki``). When provided, the site navigation is derived\n from the wiki file structure and placed before the navigation\n groups defined in ``nav_file``.\n\nRaises:\n click.FileError:\n If the navigation specification, template, or wiki directory\n cannot be found."
|
|
||||||
},
|
|
||||||
"build": {
|
|
||||||
"name": "build",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.build",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('build', 'docforge.cli.mkdocs_utils.build')>",
|
|
||||||
"docstring": "Build the MkDocs documentation site.\n\nThis function loads the MkDocs configuration and runs the MkDocs\nbuild command to generate the final static documentation site.\n\nArgs:\n mkdocs_yml (Path):\n Path to the `mkdocs.yml` configuration file.\n\nRaises:\n click.ClickException:\n If the configuration file does not exist."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.mkdocs_utils.serve",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('serve', 'docforge.cli.mkdocs_utils.serve')>",
|
|
||||||
"docstring": "Start an MkDocs development server with live reload.\n\nThe server watches documentation files and automatically reloads\nthe site when changes are detected.\n\nArgs:\n mkdocs_yml (Path):\n Path to the `mkdocs.yml` configuration file.\n\nRaises:\n click.ClickException:\n If the configuration file does not exist."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.loaders.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.commands.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"cli": {
|
|
||||||
"name": "cli",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.commands.cli",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"build": {
|
|
||||||
"name": "build",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.build",
|
|
||||||
"signature": "<bound method Function.signature of Function('build', 38, 260)>",
|
|
||||||
"docstring": "Build documentation artifacts.\n\nThis command runs the full documentation pipeline: it loads Python\nmodules, generates renderer-specific documentation sources, and\noptionally builds or serves the final output.\n\nDepending on the selected options, the build can target:\n\n- MkDocs static documentation sites for library reference docs\n- Swagger-enabled API docs generated from an OpenAPI spec\n- Hand-written wiki pages included in the MkDocs site\n- MCP structured documentation resources\n\nNotes:\n - At least one of `--mcp`, `--mkdocs`, `--wiki`, or `--api` must be\n provided.\n - `--mkdocs`, `--api`, and `--wiki` are combined into a single MkDocs\n build, while `--mcp` emits a machine-readable bundle.\n\nArgs:\n mcp (bool):\n Enable MCP documentation generation.\n\n mkdocs (bool):\n Enable MkDocs library documentation generation.\n\n api (bool):\n Enable API documentation generation from an OpenAPI spec.\n\n wiki (bool):\n Include a hand-written wiki directory in the MkDocs site.\n\n module_is_source (bool):\n Treat the specified module directory as the project root.\n\n module (str | None):\n Python module import path to document.\n\n openapi_spec (Path | None):\n Path to the OpenAPI JSON specification used for API docs.\n\n project_name (str | None):\n Optional override for the project name.\n\n site_name (str | None):\n Display name for the MkDocs site.\n\n docs_dir (Path):\n Shared documentation root used as the MkDocs ``docs_dir``.\n\n wiki_dir (Path):\n Directory containing hand-written wiki markdown files.\n\n nav_file (Path):\n Path to the navigation specification file.\n\n template (Path | None):\n Optional custom MkDocs configuration template.\n\n mkdocs_yml (Path):\n Output path for the generated MkDocs configuration.\n\n out_dir (Path):\n Output directory for generated MCP resources.\n\nRaises:\n click.UsageError:\n If required options are missing or conflicting."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.serve",
|
|
||||||
"signature": "<bound method Function.signature of Function('serve', 263, 324)>",
|
|
||||||
"docstring": "Serve generated documentation locally.\n\nDepending on the selected mode, this command starts either:\n\n- A MkDocs development server for browsing documentation\n- An MCP server exposing structured documentation resources\n\nArgs:\n mcp (bool):\n Serve documentation using the MCP server.\n\n mkdocs (bool):\n Serve the MkDocs development site.\n\n module (str | None):\n Python module import path to serve via MCP.\n\n mkdocs_yml (Path):\n Path to the MkDocs configuration file.\n\n out_dir (Path):\n Root directory containing MCP documentation resources.\n\nRaises:\n click.UsageError:\n If invalid or conflicting options are provided."
|
|
||||||
},
|
|
||||||
"tree": {
|
|
||||||
"name": "tree",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.commands.tree",
|
|
||||||
"signature": "<bound method Function.signature of Function('tree', 327, 363)>",
|
|
||||||
"docstring": "Display the documentation object tree for a module.\n\nThis command introspects the specified module and prints a\nhierarchical representation of the discovered documentation\nobjects, including modules, classes, functions, and members.\n\nArgs:\n module (str):\n Python module import path to introspect.\n\n project_name (str | None):\n Optional name to display as the project root."
|
|
||||||
},
|
|
||||||
"Group": {
|
|
||||||
"name": "Group",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.commands.Group",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Group', 'click.core.Group')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mcp_utils": {
|
|
||||||
"name": "mcp_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.mcp_utils",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nUtilities for working with MCP in the doc-forge CLI.\n\n---\n\nNotes:\n - `generate_resources` produces the bundle consumed by `MCPServer`:\n `index.json`, `nav.json`, and per-module resources under `modules/`.\n - Resource URIs use the `docs://` scheme: `docs://index`, `docs://nav`,\n and `docs://modules/{module}`.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mcp_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mcp_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mcp_utils.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.loaders.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.loaders.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"MCPRenderer": {
|
|
||||||
"name": "MCPRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPRenderer', 'docforge.renderers.MCPRenderer')>",
|
|
||||||
"docstring": "Renderer that generates MCP-compatible documentation resources.\n\nThis renderer converts doc-forge project models into structured JSON\nresources suitable for consumption by systems implementing the Model\nContext Protocol (MCP).",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mcp_renderer.MCPRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mcp_renderer.MCPRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate MCP documentation resources for a project.\n\nThe renderer serializes each module into a JSON resource and produces\nsupporting metadata files such as `nav.json` and `index.json`.\n\nArgs:\n project (Project):\n Documentation project model to render.\n\n out_dir (Path):\n Directory where MCP resources will be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MCPServer": {
|
|
||||||
"name": "MCPServer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPServer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPServer', 'docforge.servers.MCPServer')>",
|
|
||||||
"docstring": "MCP server for serving a pre-generated documentation bundle.\n\nThe server exposes documentation resources and diagnostic tools through\nMCP endpoints backed by JSON files generated by the MCP renderer.\n\nAttributes:\n mcp_root (Path):\n Directory containing the generated MCP documentation bundle.\n\n app (FastMCP):\n Underlying FastMCP application instance that registers resources\n and tools.",
|
|
||||||
"members": {
|
|
||||||
"mcp_root": {
|
|
||||||
"name": "mcp_root",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPServer.mcp_root",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mcp_root', 'docforge.servers.mcp_server.MCPServer.mcp_root')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"app": {
|
|
||||||
"name": "app",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPServer.app",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('app', 'docforge.servers.mcp_server.MCPServer.app')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"run": {
|
|
||||||
"name": "run",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPServer.run",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('run', 'docforge.servers.mcp_server.MCPServer.run')>",
|
|
||||||
"docstring": "Start the MCP server.\n\nArgs:\n transport (Literal[\"stdio\", \"sse\", \"streamable-http\"]):\n Transport mechanism used by the MCP server. Supported options\n include `stdio`, `sse`, and `streamable-http`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"generate_resources": {
|
|
||||||
"name": "generate_resources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.generate_resources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_resources', 26, 52)>",
|
|
||||||
"docstring": "Generate MCP documentation resources from a Python module.\n\nThe function performs project introspection, builds the internal\ndocumentation model, and renders MCP-compatible JSON resources\nto the specified output directory.\n\nArgs:\n module (str):\n Python module import path used as the entry point for\n documentation generation.\n\n project_name (str | None):\n Optional override for the project name used in generated\n documentation metadata.\n\n out_dir (Path):\n Directory where MCP resources (index.json, nav.json, and module data)\n will be written."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.serve",
|
|
||||||
"signature": "<bound method Function.signature of Function('serve', 55, 92)>",
|
|
||||||
"docstring": "Start an MCP server for a pre-generated documentation bundle.\n\nThe server exposes documentation resources such as project metadata,\nnavigation structure, and module documentation through MCP endpoints.\n\nArgs:\n module (str):\n Python module import path used to identify the served\n documentation instance.\n\n mcp_root (Path):\n Path to the directory containing the MCP documentation\n bundle (index.json, nav.json, and modules/).\n\nRaises:\n click.ClickException:\n If the MCP documentation bundle is missing required files or directories."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mkdocs_utils": {
|
|
||||||
"name": "mkdocs_utils",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.cli.mkdocs_utils",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nUtilities for working with MkDocs in the doc-forge CLI.\n\n---\n\nNotes:\n - A single generated `mkdocs.yml` serves lib, api, and wiki content with\n merged navigation. Wiki navigation, when enabled, precedes every other\n group and its `index.md` becomes the site `Home`.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"os": {
|
|
||||||
"name": "os",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.os",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('os', 'os')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"resources": {
|
|
||||||
"name": "resources",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.resources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resources', 'importlib.resources')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"yaml": {
|
|
||||||
"name": "yaml",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.yaml",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('yaml', 'yaml')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.loaders.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.loaders.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"MkDocsNavEmitter": {
|
|
||||||
"name": "MkDocsNavEmitter",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsNavEmitter",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsNavEmitter', 'docforge.nav.MkDocsNavEmitter')>",
|
|
||||||
"docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
|
|
||||||
"members": {
|
|
||||||
"emit": {
|
|
||||||
"name": "emit",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsNavEmitter.emit",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('emit', 'docforge.nav.mkdocs.MkDocsNavEmitter.emit')>",
|
|
||||||
"docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n nav (ResolvedNav):\n Resolved navigation data describing documentation groups\n and their associated Markdown files.\n\nReturns:\n list[dict[str, Any]]:\n A list of dictionaries representing the MkDocs navigation layout.\n Each dictionary maps a navigation label to a page or a list of\n pages."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"build_wiki_nav": {
|
|
||||||
"name": "build_wiki_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.build_wiki_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('build_wiki_nav', 'docforge.nav.build_wiki_nav')>",
|
|
||||||
"docstring": "Derive an MkDocs navigation block from a wiki directory.\n\nReturned paths are relative to the parent of ``wiki_dir`` and carry the\nwiki directory name as their leading component (for example\n``wiki/01_overview.md`` when the wiki lives at ``docs/wiki``). This makes\nthe result directly usable in an MkDocs ``nav`` block with\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.\n\nArgs:\n wiki_dir (Path):\n Path to the hand-written wiki directory, for example ``docs/wiki``.\n\nReturns:\n list[dict[str, Any]]:\n Navigation entries compatible with the MkDocs ``nav`` configuration.\n The list is empty if the wiki contains no Markdown files.\n\nRaises:\n FileNotFoundError:\n If the wiki directory does not exist."
|
|
||||||
},
|
|
||||||
"load_nav_spec": {
|
|
||||||
"name": "load_nav_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.load_nav_spec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_nav_spec', 'docforge.nav.load_nav_spec')>",
|
|
||||||
"docstring": "Load a navigation specification file.\n\nThis helper function reads a YAML navigation file and constructs a\ncorresponding ``NavSpec`` instance.\n\nArgs:\n path (Path):\n Path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed specification.\n\nRaises:\n FileNotFoundError: If the specification file does not exist.\n ValueError: If the YAML structure is invalid."
|
|
||||||
},
|
|
||||||
"resolve_nav": {
|
|
||||||
"name": "resolve_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.resolve_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resolve_nav', 'docforge.nav.resolve_nav')>",
|
|
||||||
"docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n spec (NavSpec):\n Navigation specification describing documentation layout.\n docs_root (Path):\n Root directory containing documentation Markdown files.\n\nReturns:\n ResolvedNav:\n A `ResolvedNav` instance containing validated navigation paths.\n\nRaises:\n FileNotFoundError: If the documentation root does not exist or a\n navigation pattern does not match any files."
|
|
||||||
},
|
|
||||||
"MkDocsRenderer": {
|
|
||||||
"name": "MkDocsRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsRenderer', 'docforge.renderers.MkDocsRenderer')>",
|
|
||||||
"docstring": "Renderer that produces Markdown documentation for MkDocs.\n\nGenerated pages use mkdocstrings directives to reference Python modules,\nallowing MkDocs to render API documentation dynamically.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate Markdown documentation files for a project.\n\nThis method renders a documentation structure from the provided\nproject model and writes the resulting Markdown files to the\nspecified output directory.\n\nArgs:\n project (Project):\n Project model containing modules to document.\n\n out_dir (Path):\n Directory where generated Markdown files will be written.\n\n module_is_source (bool | None):\n If True, treat the specified module as the documentation root\n rather than nesting it inside a folder."
|
|
||||||
},
|
|
||||||
"generate_readme": {
|
|
||||||
"name": "generate_readme",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsRenderer.generate_readme",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_readme', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme')>",
|
|
||||||
"docstring": "Generate a `README.md` file from the root module docstring.\n\nNotes:\n - If `module_is_source` is True, `README.md` is written to the\n project root directory.\n - If False, README generation is currently not implemented.\n\nArgs:\n project (Project):\n Project model containing documentation metadata.\n\n docs_dir (Path):\n Directory containing generated documentation sources.\n\n module_is_source (bool | None):\n Whether the module is treated as the project source root.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written.\n Defaults to the parent of `docs_dir`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.generate_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_sources', 34, 83)>",
|
|
||||||
"docstring": "Generate MkDocs Markdown sources for a Python module.\n\nThis function introspects the specified module, builds the internal\ndocumentation model, and renders Markdown documentation files for\nuse with MkDocs.\n\nArgs:\n module (str):\n Python module import path used as the entry point for\n documentation generation.\n\n docs_dir (Path):\n Directory where the generated Markdown files will be written.\n\n project_name (str | None):\n Optional override for the project name used in documentation metadata.\n\n module_is_source (bool | None):\n If True, treat the specified module directory as the project root\n rather than a nested module.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written. If not\n provided, defaults to the parent of ``docs_dir``."
|
|
||||||
},
|
|
||||||
"generate_config": {
|
|
||||||
"name": "generate_config",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.generate_config",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_config', 86, 186)>",
|
|
||||||
"docstring": "Generate an `mkdocs.yml` configuration file.\n\nThe configuration is created by combining a template configuration\nwith a navigation structure derived from the docforge navigation\nspecification (and, when a wiki directory is provided, from the wiki\nfile structure).\n\nThe ``docs_dir`` is always written relative to the MkDocs root and is\nexpected to be the shared documentation parent (for example ``docs``),\nwith generated sources nested under ``lib/`` or ``api/`` subdirectories\nand hand-written wiki content under a ``wiki/`` subdirectory.\n\nArgs:\n docs_dir (Path):\n Shared documentation root used as the MkDocs ``docs_dir``.\n\n nav_file (Path):\n Path to the `docforge.nav.yml` navigation specification.\n\n template (Path | None):\n Optional path to a fully custom MkDocs configuration template.\n If not provided, built-in templates are merged; the provided\n template replaces the built-in templates entirely.\n\n out (Path):\n Destination path where the generated `mkdocs.yml` file will be written.\n\n site_name (str):\n Display name for the generated documentation site.\n\n modes (Iterable[str] | None):\n Documentation modes to enable. Each mode contributes its own\n built-in template fragment (for example ``lib``, ``api``, or\n ``wiki``), merged on top of the shared ``mkdocs.common.yml``\n template.\n\n site_description (str | None):\n Optional site description written into the configuration.\n\n site_author (str | None):\n Optional site author written into the configuration.\n\n wiki_dir (Path | None):\n Optional path to a hand-written wiki directory (for example\n ``docs/wiki``). When provided, the site navigation is derived\n from the wiki file structure and placed before the navigation\n groups defined in ``nav_file``.\n\nRaises:\n click.FileError:\n If the navigation specification, template, or wiki directory\n cannot be found."
|
|
||||||
},
|
|
||||||
"build": {
|
|
||||||
"name": "build",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.build",
|
|
||||||
"signature": "<bound method Function.signature of Function('build', 313, 334)>",
|
|
||||||
"docstring": "Build the MkDocs documentation site.\n\nThis function loads the MkDocs configuration and runs the MkDocs\nbuild command to generate the final static documentation site.\n\nArgs:\n mkdocs_yml (Path):\n Path to the `mkdocs.yml` configuration file.\n\nRaises:\n click.ClickException:\n If the configuration file does not exist."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.serve",
|
|
||||||
"signature": "<bound method Function.signature of Function('serve', 337, 357)>",
|
|
||||||
"docstring": "Start an MkDocs development server with live reload.\n\nThe server watches documentation files and automatically reloads\nthe site when changes are detected.\n\nArgs:\n mkdocs_yml (Path):\n Path to the `mkdocs.yml` configuration file.\n\nRaises:\n click.ClickException:\n If the configuration file does not exist."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.cli.main",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.cli.main",
|
|
||||||
"docstring": "# Summary\n\nCommand-line entry point for the doc-forge CLI.\n\nThis module exposes the executable entry point that initializes the\nClick command group defined in `docforge.cli.commands`.",
|
|
||||||
"objects": {
|
|
||||||
"cli": {
|
|
||||||
"name": "cli",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.main.cli",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('cli', 'docforge.cli.commands.cli')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"main": {
|
|
||||||
"name": "main",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.main.main",
|
|
||||||
"signature": "<bound method Function.signature of Function('main', 13, 21)>",
|
|
||||||
"docstring": "Run the doc-forge command-line interface.\n\nThis function initializes and executes the Click CLI application.\nIt is used as the console entry point when invoking `doc-forge`\nfrom the command line."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.cli.mcp_utils",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.cli.mcp_utils",
|
|
||||||
"docstring": "# Summary\n\nUtilities for working with MCP in the doc-forge CLI.\n\n---\n\nNotes:\n - `generate_resources` produces the bundle consumed by `MCPServer`:\n `index.json`, `nav.json`, and per-module resources under `modules/`.\n - Resource URIs use the `docs://` scheme: `docs://index`, `docs://nav`,\n and `docs://modules/{module}`.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mcp_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mcp_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mcp_utils.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.loaders.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.loaders.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"MCPRenderer": {
|
|
||||||
"name": "MCPRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPRenderer', 'docforge.renderers.MCPRenderer')>",
|
|
||||||
"docstring": "Renderer that generates MCP-compatible documentation resources.\n\nThis renderer converts doc-forge project models into structured JSON\nresources suitable for consumption by systems implementing the Model\nContext Protocol (MCP).",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mcp_renderer.MCPRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mcp_renderer.MCPRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate MCP documentation resources for a project.\n\nThe renderer serializes each module into a JSON resource and produces\nsupporting metadata files such as `nav.json` and `index.json`.\n\nArgs:\n project (Project):\n Documentation project model to render.\n\n out_dir (Path):\n Directory where MCP resources will be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MCPServer": {
|
|
||||||
"name": "MCPServer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPServer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPServer', 'docforge.servers.MCPServer')>",
|
|
||||||
"docstring": "MCP server for serving a pre-generated documentation bundle.\n\nThe server exposes documentation resources and diagnostic tools through\nMCP endpoints backed by JSON files generated by the MCP renderer.\n\nAttributes:\n mcp_root (Path):\n Directory containing the generated MCP documentation bundle.\n\n app (FastMCP):\n Underlying FastMCP application instance that registers resources\n and tools.",
|
|
||||||
"members": {
|
|
||||||
"mcp_root": {
|
|
||||||
"name": "mcp_root",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPServer.mcp_root",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mcp_root', 'docforge.servers.mcp_server.MCPServer.mcp_root')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"app": {
|
|
||||||
"name": "app",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPServer.app",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('app', 'docforge.servers.mcp_server.MCPServer.app')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"run": {
|
|
||||||
"name": "run",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.MCPServer.run",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('run', 'docforge.servers.mcp_server.MCPServer.run')>",
|
|
||||||
"docstring": "Start the MCP server.\n\nArgs:\n transport (Literal[\"stdio\", \"sse\", \"streamable-http\"]):\n Transport mechanism used by the MCP server. Supported options\n include `stdio`, `sse`, and `streamable-http`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"generate_resources": {
|
|
||||||
"name": "generate_resources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.generate_resources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_resources', 26, 52)>",
|
|
||||||
"docstring": "Generate MCP documentation resources from a Python module.\n\nThe function performs project introspection, builds the internal\ndocumentation model, and renders MCP-compatible JSON resources\nto the specified output directory.\n\nArgs:\n module (str):\n Python module import path used as the entry point for\n documentation generation.\n\n project_name (str | None):\n Optional override for the project name used in generated\n documentation metadata.\n\n out_dir (Path):\n Directory where MCP resources (index.json, nav.json, and module data)\n will be written."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mcp_utils.serve",
|
|
||||||
"signature": "<bound method Function.signature of Function('serve', 55, 92)>",
|
|
||||||
"docstring": "Start an MCP server for a pre-generated documentation bundle.\n\nThe server exposes documentation resources such as project metadata,\nnavigation structure, and module documentation through MCP endpoints.\n\nArgs:\n module (str):\n Python module import path used to identify the served\n documentation instance.\n\n mcp_root (Path):\n Path to the directory containing the MCP documentation\n bundle (index.json, nav.json, and modules/).\n\nRaises:\n click.ClickException:\n If the MCP documentation bundle is missing required files or directories."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,176 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.cli.mkdocs_utils",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.cli.mkdocs_utils",
|
|
||||||
"docstring": "# Summary\n\nUtilities for working with MkDocs in the doc-forge CLI.\n\n---\n\nNotes:\n - A single generated `mkdocs.yml` serves lib, api, and wiki content with\n merged navigation. Wiki navigation, when enabled, precedes every other\n group and its `index.md` becomes the site `Home`.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"os": {
|
|
||||||
"name": "os",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.os",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('os', 'os')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"resources": {
|
|
||||||
"name": "resources",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.resources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resources', 'importlib.resources')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"click": {
|
|
||||||
"name": "click",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.click",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('click', 'click')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"yaml": {
|
|
||||||
"name": "yaml",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.yaml",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('yaml', 'yaml')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.loaders.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.loaders.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"MkDocsNavEmitter": {
|
|
||||||
"name": "MkDocsNavEmitter",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsNavEmitter",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsNavEmitter', 'docforge.nav.MkDocsNavEmitter')>",
|
|
||||||
"docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
|
|
||||||
"members": {
|
|
||||||
"emit": {
|
|
||||||
"name": "emit",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsNavEmitter.emit",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('emit', 'docforge.nav.mkdocs.MkDocsNavEmitter.emit')>",
|
|
||||||
"docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n nav (ResolvedNav):\n Resolved navigation data describing documentation groups\n and their associated Markdown files.\n\nReturns:\n list[dict[str, Any]]:\n A list of dictionaries representing the MkDocs navigation layout.\n Each dictionary maps a navigation label to a page or a list of\n pages."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"build_wiki_nav": {
|
|
||||||
"name": "build_wiki_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.build_wiki_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('build_wiki_nav', 'docforge.nav.build_wiki_nav')>",
|
|
||||||
"docstring": "Derive an MkDocs navigation block from a wiki directory.\n\nReturned paths are relative to the parent of ``wiki_dir`` and carry the\nwiki directory name as their leading component (for example\n``wiki/01_overview.md`` when the wiki lives at ``docs/wiki``). This makes\nthe result directly usable in an MkDocs ``nav`` block with\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.\n\nArgs:\n wiki_dir (Path):\n Path to the hand-written wiki directory, for example ``docs/wiki``.\n\nReturns:\n list[dict[str, Any]]:\n Navigation entries compatible with the MkDocs ``nav`` configuration.\n The list is empty if the wiki contains no Markdown files.\n\nRaises:\n FileNotFoundError:\n If the wiki directory does not exist."
|
|
||||||
},
|
|
||||||
"load_nav_spec": {
|
|
||||||
"name": "load_nav_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.load_nav_spec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_nav_spec', 'docforge.nav.load_nav_spec')>",
|
|
||||||
"docstring": "Load a navigation specification file.\n\nThis helper function reads a YAML navigation file and constructs a\ncorresponding ``NavSpec`` instance.\n\nArgs:\n path (Path):\n Path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed specification.\n\nRaises:\n FileNotFoundError: If the specification file does not exist.\n ValueError: If the YAML structure is invalid."
|
|
||||||
},
|
|
||||||
"resolve_nav": {
|
|
||||||
"name": "resolve_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.resolve_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resolve_nav', 'docforge.nav.resolve_nav')>",
|
|
||||||
"docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n spec (NavSpec):\n Navigation specification describing documentation layout.\n docs_root (Path):\n Root directory containing documentation Markdown files.\n\nReturns:\n ResolvedNav:\n A `ResolvedNav` instance containing validated navigation paths.\n\nRaises:\n FileNotFoundError: If the documentation root does not exist or a\n navigation pattern does not match any files."
|
|
||||||
},
|
|
||||||
"MkDocsRenderer": {
|
|
||||||
"name": "MkDocsRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsRenderer', 'docforge.renderers.MkDocsRenderer')>",
|
|
||||||
"docstring": "Renderer that produces Markdown documentation for MkDocs.\n\nGenerated pages use mkdocstrings directives to reference Python modules,\nallowing MkDocs to render API documentation dynamically.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate Markdown documentation files for a project.\n\nThis method renders a documentation structure from the provided\nproject model and writes the resulting Markdown files to the\nspecified output directory.\n\nArgs:\n project (Project):\n Project model containing modules to document.\n\n out_dir (Path):\n Directory where generated Markdown files will be written.\n\n module_is_source (bool | None):\n If True, treat the specified module as the documentation root\n rather than nesting it inside a folder."
|
|
||||||
},
|
|
||||||
"generate_readme": {
|
|
||||||
"name": "generate_readme",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.MkDocsRenderer.generate_readme",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_readme', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme')>",
|
|
||||||
"docstring": "Generate a `README.md` file from the root module docstring.\n\nNotes:\n - If `module_is_source` is True, `README.md` is written to the\n project root directory.\n - If False, README generation is currently not implemented.\n\nArgs:\n project (Project):\n Project model containing documentation metadata.\n\n docs_dir (Path):\n Directory containing generated documentation sources.\n\n module_is_source (bool | None):\n Whether the module is treated as the project source root.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written.\n Defaults to the parent of `docs_dir`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.generate_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_sources', 34, 83)>",
|
|
||||||
"docstring": "Generate MkDocs Markdown sources for a Python module.\n\nThis function introspects the specified module, builds the internal\ndocumentation model, and renders Markdown documentation files for\nuse with MkDocs.\n\nArgs:\n module (str):\n Python module import path used as the entry point for\n documentation generation.\n\n docs_dir (Path):\n Directory where the generated Markdown files will be written.\n\n project_name (str | None):\n Optional override for the project name used in documentation metadata.\n\n module_is_source (bool | None):\n If True, treat the specified module directory as the project root\n rather than a nested module.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written. If not\n provided, defaults to the parent of ``docs_dir``."
|
|
||||||
},
|
|
||||||
"generate_config": {
|
|
||||||
"name": "generate_config",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.generate_config",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_config', 86, 186)>",
|
|
||||||
"docstring": "Generate an `mkdocs.yml` configuration file.\n\nThe configuration is created by combining a template configuration\nwith a navigation structure derived from the docforge navigation\nspecification (and, when a wiki directory is provided, from the wiki\nfile structure).\n\nThe ``docs_dir`` is always written relative to the MkDocs root and is\nexpected to be the shared documentation parent (for example ``docs``),\nwith generated sources nested under ``lib/`` or ``api/`` subdirectories\nand hand-written wiki content under a ``wiki/`` subdirectory.\n\nArgs:\n docs_dir (Path):\n Shared documentation root used as the MkDocs ``docs_dir``.\n\n nav_file (Path):\n Path to the `docforge.nav.yml` navigation specification.\n\n template (Path | None):\n Optional path to a fully custom MkDocs configuration template.\n If not provided, built-in templates are merged; the provided\n template replaces the built-in templates entirely.\n\n out (Path):\n Destination path where the generated `mkdocs.yml` file will be written.\n\n site_name (str):\n Display name for the generated documentation site.\n\n modes (Iterable[str] | None):\n Documentation modes to enable. Each mode contributes its own\n built-in template fragment (for example ``lib``, ``api``, or\n ``wiki``), merged on top of the shared ``mkdocs.common.yml``\n template.\n\n site_description (str | None):\n Optional site description written into the configuration.\n\n site_author (str | None):\n Optional site author written into the configuration.\n\n wiki_dir (Path | None):\n Optional path to a hand-written wiki directory (for example\n ``docs/wiki``). When provided, the site navigation is derived\n from the wiki file structure and placed before the navigation\n groups defined in ``nav_file``.\n\nRaises:\n click.FileError:\n If the navigation specification, template, or wiki directory\n cannot be found."
|
|
||||||
},
|
|
||||||
"build": {
|
|
||||||
"name": "build",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.build",
|
|
||||||
"signature": "<bound method Function.signature of Function('build', 313, 334)>",
|
|
||||||
"docstring": "Build the MkDocs documentation site.\n\nThis function loads the MkDocs configuration and runs the MkDocs\nbuild command to generate the final static documentation site.\n\nArgs:\n mkdocs_yml (Path):\n Path to the `mkdocs.yml` configuration file.\n\nRaises:\n click.ClickException:\n If the configuration file does not exist."
|
|
||||||
},
|
|
||||||
"serve": {
|
|
||||||
"name": "serve",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.cli.mkdocs_utils.serve",
|
|
||||||
"signature": "<bound method Function.signature of Function('serve', 337, 357)>",
|
|
||||||
"docstring": "Start an MkDocs development server with live reload.\n\nThe server watches documentation files and automatically reloads\nthe site when changes are detected.\n\nArgs:\n mkdocs_yml (Path):\n Path to the `mkdocs.yml` configuration file.\n\nRaises:\n click.ClickException:\n If the configuration file does not exist."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
File diff suppressed because one or more lines are too long
@@ -1,262 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.loaders.griffe_loader",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.loaders.griffe_loader",
|
|
||||||
"docstring": "# Summary\n\nUtilities for loading and introspecting Python modules using Griffe.\n\nThis module provides the `GriffeLoader` class and helper utilities used to\ndiscover Python modules, introspect their structure, and convert the results\ninto doc-forge documentation models.\n\n---\n\nNotes:\n - All analysis is static; analyzed modules are never executed.\n - Private members (names starting with `_`) are skipped during conversion.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"logging": {
|
|
||||||
"name": "logging",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.logging",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('logging', 'logging')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"AliasResolutionError": {
|
|
||||||
"name": "AliasResolutionError",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.AliasResolutionError",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('AliasResolutionError', 'griffe.AliasResolutionError')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"LinesCollection": {
|
|
||||||
"name": "LinesCollection",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.LinesCollection",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('LinesCollection', 'griffe.LinesCollection')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"ModulesCollection": {
|
|
||||||
"name": "ModulesCollection",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.ModulesCollection",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('ModulesCollection', 'griffe.ModulesCollection')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Object": {
|
|
||||||
"name": "Object",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Object', 'griffe.Object')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"logger": {
|
|
||||||
"name": "logger",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.logger",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.discover_module_paths",
|
|
||||||
"signature": "<bound method Function.signature of Function('discover_module_paths', 37, 89)>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.griffe_loader.GriffeLoader",
|
|
||||||
"signature": "<bound method Class.signature of Class('GriffeLoader', 92, 315)>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Function.signature of Function('load_project', 117, 171)>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Function.signature of Function('load_module', 173, 206)>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,301 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.loaders",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.loaders",
|
|
||||||
"docstring": "# Summary\n\nLoader layer for doc-forge.\n\nThe `docforge.loaders` package is responsible for discovering Python modules\nand extracting documentation data using static analysis.\n\n---\n\n# Overview\n\nThis layer converts Python source code into an intermediate documentation\nmodel used by doc-forge. It performs module discovery, introspection, and\ninitial filtering before the data is passed to the core documentation models.\n\nCore capabilities include:\n\n- **Module discovery** – Locate Python modules and packages within a project.\n- **Static introspection** – Parse docstrings, signatures, and object\n hierarchies using the `griffe` library without executing the code.\n- **Public API filtering** – Exclude private members (names prefixed with\n `_`) to produce clean public documentation structures.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.GriffeLoader",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('GriffeLoader', 'docforge.loaders.griffe_loader.GriffeLoader')>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_project', 'docforge.loaders.griffe_loader.GriffeLoader.load_project')>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_module', 'docforge.loaders.griffe_loader.GriffeLoader.load_module')>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.discover_module_paths",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('discover_module_paths', 'docforge.loaders.griffe_loader.discover_module_paths')>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"griffe_loader": {
|
|
||||||
"name": "griffe_loader",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.loaders.griffe_loader",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nUtilities for loading and introspecting Python modules using Griffe.\n\nThis module provides the `GriffeLoader` class and helper utilities used to\ndiscover Python modules, introspect their structure, and convert the results\ninto doc-forge documentation models.\n\n---\n\nNotes:\n - All analysis is static; analyzed modules are never executed.\n - Private members (names starting with `_`) are skipped during conversion.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"logging": {
|
|
||||||
"name": "logging",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.logging",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('logging', 'logging')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"AliasResolutionError": {
|
|
||||||
"name": "AliasResolutionError",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.AliasResolutionError",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('AliasResolutionError', 'griffe.AliasResolutionError')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"LinesCollection": {
|
|
||||||
"name": "LinesCollection",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.LinesCollection",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('LinesCollection', 'griffe.LinesCollection')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"ModulesCollection": {
|
|
||||||
"name": "ModulesCollection",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.ModulesCollection",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('ModulesCollection', 'griffe.ModulesCollection')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Object": {
|
|
||||||
"name": "Object",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Object', 'griffe.Object')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"logger": {
|
|
||||||
"name": "logger",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.loaders.griffe_loader.logger",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"discover_module_paths": {
|
|
||||||
"name": "discover_module_paths",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.discover_module_paths",
|
|
||||||
"signature": "<bound method Function.signature of Function('discover_module_paths', 37, 89)>",
|
|
||||||
"docstring": "Discover Python modules within a package directory.\n\nThe function scans the filesystem for `.py` files inside the specified\npackage and converts them into dotted module import paths.\n\nDiscovery rules:\n\n- Directories containing `__init__.py` are treated as packages.\n- Each `.py` file is treated as a module.\n- Results are returned as dotted import paths.\n\nArgs:\n module_name (str):\n Top-level package name to discover modules from.\n\n project_root (Path | None):\n Root directory used to resolve module paths. If not provided, the\n current working directory is used.\n\nReturns:\n list[str]:\n A sorted list of unique dotted module import paths.\n\nRaises:\n FileNotFoundError:\n If the specified package directory does not exist."
|
|
||||||
},
|
|
||||||
"GriffeLoader": {
|
|
||||||
"name": "GriffeLoader",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.loaders.griffe_loader.GriffeLoader",
|
|
||||||
"signature": "<bound method Class.signature of Class('GriffeLoader', 92, 315)>",
|
|
||||||
"docstring": "Load Python modules using Griffe and convert them into doc-forge models.\n\nThis loader uses the Griffe introspection engine to analyze Python source\ncode and transform the extracted information into `Project`, `Module`,\nand `DocObject` instances used by doc-forge.\n\nAttributes:\n _loader (_GriffeLoader):\n Internal Griffe loader with dedicated module and line collections.",
|
|
||||||
"members": {
|
|
||||||
"load_project": {
|
|
||||||
"name": "load_project",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.GriffeLoader.load_project",
|
|
||||||
"signature": "<bound method Function.signature of Function('load_project', 117, 171)>",
|
|
||||||
"docstring": "Load multiple modules and assemble them into a Project model.\n\nEach module path is introspected and converted into a `Module`\ninstance. All modules are then aggregated into a single `Project`\nobject.\n\nArgs:\n module_paths (list[str]):\n List of dotted module import paths to load.\n\n project_name (str | None):\n Optional override for the project name. Defaults to the top-level\n name of the first module.\n\n skip_import_errors (bool | None):\n If True, modules that fail to load will be skipped instead of raising an error.\n\nReturns:\n Project:\n A populated `Project` instance containing the loaded modules.\n\nRaises:\n ValueError:\n If no module paths are provided.\n\n ImportError:\n If a module fails to load and `skip_import_errors` is False."
|
|
||||||
},
|
|
||||||
"load_module": {
|
|
||||||
"name": "load_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.loaders.griffe_loader.GriffeLoader.load_module",
|
|
||||||
"signature": "<bound method Function.signature of Function('load_module', 173, 206)>",
|
|
||||||
"docstring": "Load and convert a single Python module.\n\nThe module is introspected using Griffe and then transformed into\na doc-forge `Module` model.\n\nArgs:\n path (str):\n Dotted import path of the module.\n\nReturns:\n Module:\n A populated `Module` instance.\n\nRaises:\n ImportError:\n If the module cannot be loaded by Griffe.\n\n KeyError:\n If the loaded module is missing from the module collection.\n\nExample:\n Load a single module:\n\n ```python\n loader = GriffeLoader()\n module = loader.load_module(\"mypackage.submodule\")\n ```"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,528 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.models",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.models",
|
|
||||||
"docstring": "# Summary\n\nModel layer for doc-forge.\n\nThe `docforge.models` package defines the core data structures used to\nrepresent Python source code as a structured documentation model.\n\n---\n\n# Overview\n\nThe model layer forms the central intermediate representation used throughout\ndoc-forge. Python modules and objects discovered during introspection are\nconverted into a hierarchy of documentation models that can later be rendered\ninto different documentation formats.\n\nKey components:\n\n- **Project** – Root container representing an entire documented codebase.\n- **Module** – Representation of a Python module or package containing\n documented members.\n- **DocObject** – Recursive structure representing Python objects such as\n classes, functions, methods, and attributes.\n\nThese models are intentionally **renderer-agnostic**, allowing the same\ndocumentation structure to be transformed into multiple output formats\n(e.g., MkDocs, MCP, or other renderers).\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.project.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.module.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.object.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"module": {
|
|
||||||
"name": "module",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.models.module",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nDocumentation model representing a Python module or package.\n\nThis module defines the `Module` class used in the doc-forge documentation\nmodel. A `Module` acts as a container for top-level documented objects\n(classes, functions, variables, and other members) discovered during\nintrospection.\n\n---\n\nNotes:\n - Only public members are stored; private names are filtered by the loader.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.models.module.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.module.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.object.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.module.Module",
|
|
||||||
"signature": "<bound method Class.signature of Class('Module', 24, 98)>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.Module.path",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.Module.docstring",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.Module.members",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.Module.add_object",
|
|
||||||
"signature": "<bound method Function.signature of Function('add_object', 62, 70)>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.Module.get_object",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_object', 72, 88)>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_all_objects', 90, 98)>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"object": {
|
|
||||||
"name": "object",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.models.object",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nDocumentation model representing individual Python objects.\n\nThis module defines the `DocObject` class, the fundamental recursive unit of\nthe doc-forge documentation model. Each `DocObject` represents a Python\nentity such as a class, function, method, or attribute, and may contain nested\nmembers that form a hierarchical documentation structure.\n\n---\n\nNotes:\n - `DocObject` instances form a tree mirroring the Python import hierarchy.\n - Objects are renderer-agnostic and may be consumed by any renderer.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.models.object.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.object.DocObject",
|
|
||||||
"signature": "<bound method Class.signature of Class('DocObject', 23, 124)>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.kind",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.path",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.signature",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.docstring",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.members",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.object.DocObject.add_member",
|
|
||||||
"signature": "<bound method Function.signature of Function('add_member', 85, 96)>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.object.DocObject.get_member",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_member', 98, 114)>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.object.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_all_members', 116, 124)>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"project": {
|
|
||||||
"name": "project",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.models.project",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nDocumentation model representing a project.\n\nThis module defines the `Project` class, the top-level container used by\ndoc-forge to represent a documented codebase. A `Project` aggregates multiple\nmodules and provides access to them through a unified interface.\n\n---\n\nNotes:\n - Modules are keyed by their dotted import path.\n - Objects are renderer-agnostic; the same model feeds every renderer.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.models.project.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.project.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.module.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.project.Project",
|
|
||||||
"signature": "<bound method Class.signature of Class('Project', 24, 104)>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Project.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Project.modules",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Project.add_module",
|
|
||||||
"signature": "<bound method Function.signature of Function('add_module', 58, 66)>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Project.get_module",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_module', 68, 84)>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_all_modules', 86, 94)>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Project.get_module_list",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_module_list', 96, 104)>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,139 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.models.module",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.models.module",
|
|
||||||
"docstring": "# Summary\n\nDocumentation model representing a Python module or package.\n\nThis module defines the `Module` class used in the doc-forge documentation\nmodel. A `Module` acts as a container for top-level documented objects\n(classes, functions, variables, and other members) discovered during\nintrospection.\n\n---\n\nNotes:\n - Only public members are stored; private names are filtered by the loader.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.models.module.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.module.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.object.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.module.Module",
|
|
||||||
"signature": "<bound method Class.signature of Class('Module', 24, 98)>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.Module.path",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.Module.docstring",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.module.Module.members",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.Module.add_object",
|
|
||||||
"signature": "<bound method Function.signature of Function('add_object', 62, 70)>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.Module.get_object",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_object', 72, 88)>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.module.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_all_objects', 90, 98)>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.models.object",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.models.object",
|
|
||||||
"docstring": "# Summary\n\nDocumentation model representing individual Python objects.\n\nThis module defines the `DocObject` class, the fundamental recursive unit of\nthe doc-forge documentation model. Each `DocObject` represents a Python\nentity such as a class, function, method, or attribute, and may contain nested\nmembers that form a hierarchical documentation structure.\n\n---\n\nNotes:\n - `DocObject` instances form a tree mirroring the Python import hierarchy.\n - Objects are renderer-agnostic and may be consumed by any renderer.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.models.object.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.object.DocObject",
|
|
||||||
"signature": "<bound method Class.signature of Class('DocObject', 23, 124)>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.kind",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.path",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.signature",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.docstring",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.object.DocObject.members",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.object.DocObject.add_member",
|
|
||||||
"signature": "<bound method Function.signature of Function('add_member', 85, 96)>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.object.DocObject.get_member",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_member', 98, 114)>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.object.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_all_members', 116, 124)>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,118 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.models.project",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.models.project",
|
|
||||||
"docstring": "# Summary\n\nDocumentation model representing a project.\n\nThis module defines the `Project` class, the top-level container used by\ndoc-forge to represent a documented codebase. A `Project` aggregates multiple\nmodules and provides access to them through a unified interface.\n\n---\n\nNotes:\n - Modules are keyed by their dotted import path.\n - Objects are renderer-agnostic; the same model feeds every renderer.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.models.project.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.project.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.module.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.models.project.Project",
|
|
||||||
"signature": "<bound method Class.signature of Class('Project', 24, 104)>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Project.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.models.project.Project.modules",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Project.add_module",
|
|
||||||
"signature": "<bound method Function.signature of Function('add_module', 58, 66)>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Project.get_module",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_module', 68, 84)>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_all_modules', 86, 94)>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.models.project.Project.get_module_list",
|
|
||||||
"signature": "<bound method Function.signature of Function('get_module_list', 96, 104)>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,425 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.nav",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.nav",
|
|
||||||
"docstring": "Navigation layer for doc-forge.\n\nThe ``docforge.nav`` package manages the relationship between the logical\ndocumentation structure defined by the user and the physical documentation\nfiles generated on disk.\n\n---\n\nWorkflow\n--------\n\n1. **Specification** – Users define navigation intent in ``docforge.nav.yml``.\n2. **Resolution** – ``resolve_nav`` expands patterns and matches them against\n generated Markdown files.\n3. **Emission** – ``MkDocsNavEmitter`` converts the resolved structure into\n the YAML navigation format required by ``mkdocs.yml``.\n\nThis layer separates documentation organization from the underlying source\ncode layout, enabling flexible grouping, ordering, and navigation structures\nindependent of module hierarchy.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"NavSpec": {
|
|
||||||
"name": "NavSpec",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.NavSpec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('NavSpec', 'docforge.nav.spec.NavSpec')>",
|
|
||||||
"docstring": "Parsed representation of a navigation specification.\n\nA ``NavSpec`` describes the intended documentation navigation layout before\nit is resolved against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page (for example\n ``index.md``).\n groups: Mapping of navigation group titles to lists of file patterns\n or glob expressions.\n icon: Optional mapping of theme icon entries (for example\n ``{\"logo\": \"material/code-tags\"}``) injected into the MkDocs\n theme as ``theme.icon``.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.NavSpec.home",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('home', 'docforge.nav.spec.NavSpec.home')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.NavSpec.groups",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('groups', 'docforge.nav.spec.NavSpec.groups')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"icon": {
|
|
||||||
"name": "icon",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.NavSpec.icon",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('icon', 'docforge.nav.spec.NavSpec.icon')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"load": {
|
|
||||||
"name": "load",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.NavSpec.load",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load', 'docforge.nav.spec.NavSpec.load')>",
|
|
||||||
"docstring": "Load a navigation specification from a YAML file.\n\nArgs:\n path (Path):\n Filesystem path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed configuration.\n\nRaises:\n FileNotFoundError: If the specified file does not exist.\n ValueError: If the file contents are not a valid navigation\n specification."
|
|
||||||
},
|
|
||||||
"all_patterns": {
|
|
||||||
"name": "all_patterns",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.NavSpec.all_patterns",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('all_patterns', 'docforge.nav.spec.NavSpec.all_patterns')>",
|
|
||||||
"docstring": "Return all path patterns referenced by the specification.\n\nReturns:\n list[str]:\n A list containing the home document (if defined) and all\n group pattern entries."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"load_nav_spec": {
|
|
||||||
"name": "load_nav_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.load_nav_spec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load_nav_spec', 'docforge.nav.spec.load_nav_spec')>",
|
|
||||||
"docstring": "Load a navigation specification file.\n\nThis helper function reads a YAML navigation file and constructs a\ncorresponding ``NavSpec`` instance.\n\nArgs:\n path (Path):\n Path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed specification.\n\nRaises:\n FileNotFoundError: If the specification file does not exist.\n ValueError: If the YAML structure is invalid."
|
|
||||||
},
|
|
||||||
"ResolvedNav": {
|
|
||||||
"name": "ResolvedNav",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.ResolvedNav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('ResolvedNav', 'docforge.nav.resolver.ResolvedNav')>",
|
|
||||||
"docstring": "Resolved navigation structure.\n\nA ``ResolvedNav`` represents navigation data after glob patterns have been\nexpanded and paths validated against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page.\n groups: Mapping of navigation group titles to lists of resolved\n documentation file paths.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.ResolvedNav.home",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('home', 'docforge.nav.resolver.ResolvedNav.home')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.ResolvedNav.groups",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('groups', 'docforge.nav.resolver.ResolvedNav.groups')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"all_files": {
|
|
||||||
"name": "all_files",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.ResolvedNav.all_files",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('all_files', 'docforge.nav.resolver.ResolvedNav.all_files')>",
|
|
||||||
"docstring": "Iterate over all files referenced by the navigation structure.\n\nYields:\n Path:\n A documentation file referenced by the navigation, including\n the home page when defined.\n\nRaises:\n RuntimeError: If the home page is defined but the documentation\n root is not available for resolution."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"resolve_nav": {
|
|
||||||
"name": "resolve_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolve_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('resolve_nav', 'docforge.nav.resolver.resolve_nav')>",
|
|
||||||
"docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n spec (NavSpec):\n Navigation specification describing documentation layout.\n docs_root (Path):\n Root directory containing documentation Markdown files.\n\nReturns:\n ResolvedNav:\n A `ResolvedNav` instance containing validated navigation paths.\n\nRaises:\n FileNotFoundError: If the documentation root does not exist or a\n navigation pattern does not match any files."
|
|
||||||
},
|
|
||||||
"MkDocsNavEmitter": {
|
|
||||||
"name": "MkDocsNavEmitter",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.MkDocsNavEmitter",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsNavEmitter', 'docforge.nav.mkdocs.MkDocsNavEmitter')>",
|
|
||||||
"docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
|
|
||||||
"members": {
|
|
||||||
"emit": {
|
|
||||||
"name": "emit",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.MkDocsNavEmitter.emit",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('emit', 'docforge.nav.mkdocs.MkDocsNavEmitter.emit')>",
|
|
||||||
"docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n nav (ResolvedNav):\n Resolved navigation data describing documentation groups\n and their associated Markdown files.\n\nReturns:\n list[dict[str, Any]]:\n A list of dictionaries representing the MkDocs navigation layout.\n Each dictionary maps a navigation label to a page or a list of\n pages."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"build_wiki_nav": {
|
|
||||||
"name": "build_wiki_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.build_wiki_nav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('build_wiki_nav', 'docforge.nav.wiki.build_wiki_nav')>",
|
|
||||||
"docstring": "Derive an MkDocs navigation block from a wiki directory.\n\nReturned paths are relative to the parent of ``wiki_dir`` and carry the\nwiki directory name as their leading component (for example\n``wiki/01_overview.md`` when the wiki lives at ``docs/wiki``). This makes\nthe result directly usable in an MkDocs ``nav`` block with\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.\n\nArgs:\n wiki_dir (Path):\n Path to the hand-written wiki directory, for example ``docs/wiki``.\n\nReturns:\n list[dict[str, Any]]:\n Navigation entries compatible with the MkDocs ``nav`` configuration.\n The list is empty if the wiki contains no Markdown files.\n\nRaises:\n FileNotFoundError:\n If the wiki directory does not exist."
|
|
||||||
},
|
|
||||||
"mkdocs": {
|
|
||||||
"name": "mkdocs",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.nav.mkdocs",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "MkDocs navigation emitter.\n\nThis module provides the ``MkDocsNavEmitter`` class, which converts a\n``ResolvedNav`` instance into the navigation structure required by the\nMkDocs ``nav`` configuration.\n\n---\n\nNotes:\n - The emitted structure is a list of dictionaries, one per top-level nav\n entry, matching the MkDocs ``nav`` YAML format.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.mkdocs.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.mkdocs.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"ResolvedNav": {
|
|
||||||
"name": "ResolvedNav",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.mkdocs.ResolvedNav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('ResolvedNav', 'docforge.nav.resolver.ResolvedNav')>",
|
|
||||||
"docstring": "Resolved navigation structure.\n\nA ``ResolvedNav`` represents navigation data after glob patterns have been\nexpanded and paths validated against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page.\n groups: Mapping of navigation group titles to lists of resolved\n documentation file paths.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.mkdocs.ResolvedNav.home",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('home', 'docforge.nav.resolver.ResolvedNav.home')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.mkdocs.ResolvedNav.groups",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('groups', 'docforge.nav.resolver.ResolvedNav.groups')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"all_files": {
|
|
||||||
"name": "all_files",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.mkdocs.ResolvedNav.all_files",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('all_files', 'docforge.nav.resolver.ResolvedNav.all_files')>",
|
|
||||||
"docstring": "Iterate over all files referenced by the navigation structure.\n\nYields:\n Path:\n A documentation file referenced by the navigation, including\n the home page when defined.\n\nRaises:\n RuntimeError: If the home page is defined but the documentation\n root is not available for resolution."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MkDocsNavEmitter": {
|
|
||||||
"name": "MkDocsNavEmitter",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.mkdocs.MkDocsNavEmitter",
|
|
||||||
"signature": "<bound method Class.signature of Class('MkDocsNavEmitter', 23, 94)>",
|
|
||||||
"docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
|
|
||||||
"members": {
|
|
||||||
"emit": {
|
|
||||||
"name": "emit",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.mkdocs.MkDocsNavEmitter.emit",
|
|
||||||
"signature": "<bound method Function.signature of Function('emit', 31, 61)>",
|
|
||||||
"docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n nav (ResolvedNav):\n Resolved navigation data describing documentation groups\n and their associated Markdown files.\n\nReturns:\n list[dict[str, Any]]:\n A list of dictionaries representing the MkDocs navigation layout.\n Each dictionary maps a navigation label to a page or a list of\n pages."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"resolver": {
|
|
||||||
"name": "resolver",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.nav.resolver",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "Navigation resolution utilities.\n\nThis module resolves a ``NavSpec`` against the filesystem by expanding glob\npatterns and validating that referenced documentation files exist.\n\n---\n\nNotes:\n - Glob resolution is recursive and returns paths in sorted order.\n - Unmatched patterns raise ``FileNotFoundError`` to fail fast on typos.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"glob": {
|
|
||||||
"name": "glob",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.resolver.glob",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('glob', 'glob')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.resolver.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.resolver.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"NavSpec": {
|
|
||||||
"name": "NavSpec",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('NavSpec', 'docforge.nav.spec.NavSpec')>",
|
|
||||||
"docstring": "Parsed representation of a navigation specification.\n\nA ``NavSpec`` describes the intended documentation navigation layout before\nit is resolved against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page (for example\n ``index.md``).\n groups: Mapping of navigation group titles to lists of file patterns\n or glob expressions.\n icon: Optional mapping of theme icon entries (for example\n ``{\"logo\": \"material/code-tags\"}``) injected into the MkDocs\n theme as ``theme.icon``.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.home",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('home', 'docforge.nav.spec.NavSpec.home')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.groups",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('groups', 'docforge.nav.spec.NavSpec.groups')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"icon": {
|
|
||||||
"name": "icon",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.icon",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('icon', 'docforge.nav.spec.NavSpec.icon')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"load": {
|
|
||||||
"name": "load",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.load",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load', 'docforge.nav.spec.NavSpec.load')>",
|
|
||||||
"docstring": "Load a navigation specification from a YAML file.\n\nArgs:\n path (Path):\n Filesystem path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed configuration.\n\nRaises:\n FileNotFoundError: If the specified file does not exist.\n ValueError: If the file contents are not a valid navigation\n specification."
|
|
||||||
},
|
|
||||||
"all_patterns": {
|
|
||||||
"name": "all_patterns",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.all_patterns",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('all_patterns', 'docforge.nav.spec.NavSpec.all_patterns')>",
|
|
||||||
"docstring": "Return all path patterns referenced by the specification.\n\nReturns:\n list[str]:\n A list containing the home document (if defined) and all\n group pattern entries."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"ResolvedNav": {
|
|
||||||
"name": "ResolvedNav",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.resolver.ResolvedNav",
|
|
||||||
"signature": "<bound method Class.signature of Class('ResolvedNav', 23, 76)>",
|
|
||||||
"docstring": "Resolved navigation structure.\n\nA ``ResolvedNav`` represents navigation data after glob patterns have been\nexpanded and paths validated against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page.\n groups: Mapping of navigation group titles to lists of resolved\n documentation file paths.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.ResolvedNav.home",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.ResolvedNav.groups",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"all_files": {
|
|
||||||
"name": "all_files",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolver.ResolvedNav.all_files",
|
|
||||||
"signature": "<bound method Function.signature of Function('all_files', 57, 76)>",
|
|
||||||
"docstring": "Iterate over all files referenced by the navigation structure.\n\nYields:\n Path:\n A documentation file referenced by the navigation, including\n the home page when defined.\n\nRaises:\n RuntimeError: If the home page is defined but the documentation\n root is not available for resolution."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"resolve_nav": {
|
|
||||||
"name": "resolve_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolver.resolve_nav",
|
|
||||||
"signature": "<bound method Function.signature of Function('resolve_nav', 79, 150)>",
|
|
||||||
"docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n spec (NavSpec):\n Navigation specification describing documentation layout.\n docs_root (Path):\n Root directory containing documentation Markdown files.\n\nReturns:\n ResolvedNav:\n A `ResolvedNav` instance containing validated navigation paths.\n\nRaises:\n FileNotFoundError: If the documentation root does not exist or a\n navigation pattern does not match any files."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"spec": {
|
|
||||||
"name": "spec",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.nav.spec",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "Navigation specification model.\n\nThis module defines the ``NavSpec`` class, which represents the navigation\nstructure defined by the user in the doc-forge navigation specification\n(typically ``docforge.nav.yml``).\n\n---\n\nNotes:\n - The spec file supports an optional ``icon`` mapping for MkDocs theme\n customization.\n - All file references in ``groups`` are relative to the documentation root.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"annotations": {
|
|
||||||
"name": "annotations",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.spec.annotations",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('annotations', '__future__.annotations')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.spec.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"yaml": {
|
|
||||||
"name": "yaml",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.spec.yaml",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('yaml', 'yaml')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"NavSpec": {
|
|
||||||
"name": "NavSpec",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.spec.NavSpec",
|
|
||||||
"signature": "<bound method Class.signature of Class('NavSpec', 25, 136)>",
|
|
||||||
"docstring": "Parsed representation of a navigation specification.\n\nA ``NavSpec`` describes the intended documentation navigation layout before\nit is resolved against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page (for example\n ``index.md``).\n groups: Mapping of navigation group titles to lists of file patterns\n or glob expressions.\n icon: Optional mapping of theme icon entries (for example\n ``{\"logo\": \"material/code-tags\"}``) injected into the MkDocs\n theme as ``theme.icon``.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.home",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.groups",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"icon": {
|
|
||||||
"name": "icon",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.icon",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"load": {
|
|
||||||
"name": "load",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.load",
|
|
||||||
"signature": "<bound method Function.signature of Function('load', 65, 117)>",
|
|
||||||
"docstring": "Load a navigation specification from a YAML file.\n\nArgs:\n path (Path):\n Filesystem path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed configuration.\n\nRaises:\n FileNotFoundError: If the specified file does not exist.\n ValueError: If the file contents are not a valid navigation\n specification."
|
|
||||||
},
|
|
||||||
"all_patterns": {
|
|
||||||
"name": "all_patterns",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.all_patterns",
|
|
||||||
"signature": "<bound method Function.signature of Function('all_patterns', 119, 136)>",
|
|
||||||
"docstring": "Return all path patterns referenced by the specification.\n\nReturns:\n list[str]:\n A list containing the home document (if defined) and all\n group pattern entries."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"load_nav_spec": {
|
|
||||||
"name": "load_nav_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.spec.load_nav_spec",
|
|
||||||
"signature": "<bound method Function.signature of Function('load_nav_spec', 139, 170)>",
|
|
||||||
"docstring": "Load a navigation specification file.\n\nThis helper function reads a YAML navigation file and constructs a\ncorresponding ``NavSpec`` instance.\n\nArgs:\n path (Path):\n Path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed specification.\n\nRaises:\n FileNotFoundError: If the specification file does not exist.\n ValueError: If the YAML structure is invalid."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"wiki": {
|
|
||||||
"name": "wiki",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.nav.wiki",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nWiki navigation derivation.\n\nThis module provides ``build_wiki_nav``, which derives an MkDocs-ready\nnavigation block from the file structure of a hand-written wiki directory\n(typically ``docs/wiki``). wiki content is authored by hand and is never\nmodified by doc-forge; only the navigation layout is inferred.\n\n# Notes\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.",
|
|
||||||
"members": {
|
|
||||||
"re": {
|
|
||||||
"name": "re",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.wiki.re",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('re', 're')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Callable": {
|
|
||||||
"name": "Callable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.wiki.Callable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Callable', 'collections.abc.Callable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.wiki.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.wiki.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"build_wiki_nav": {
|
|
||||||
"name": "build_wiki_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.wiki.build_wiki_nav",
|
|
||||||
"signature": "<bound method Function.signature of Function('build_wiki_nav', 28, 76)>",
|
|
||||||
"docstring": "Derive an MkDocs navigation block from a wiki directory.\n\nReturned paths are relative to the parent of ``wiki_dir`` and carry the\nwiki directory name as their leading component (for example\n``wiki/01_overview.md`` when the wiki lives at ``docs/wiki``). This makes\nthe result directly usable in an MkDocs ``nav`` block with\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.\n\nArgs:\n wiki_dir (Path):\n Path to the hand-written wiki directory, for example ``docs/wiki``.\n\nReturns:\n list[dict[str, Any]]:\n Navigation entries compatible with the MkDocs ``nav`` configuration.\n The list is empty if the wiki contains no Markdown files.\n\nRaises:\n FileNotFoundError:\n If the wiki directory does not exist."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.nav.mkdocs",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.nav.mkdocs",
|
|
||||||
"docstring": "MkDocs navigation emitter.\n\nThis module provides the ``MkDocsNavEmitter`` class, which converts a\n``ResolvedNav`` instance into the navigation structure required by the\nMkDocs ``nav`` configuration.\n\n---\n\nNotes:\n - The emitted structure is a list of dictionaries, one per top-level nav\n entry, matching the MkDocs ``nav`` YAML format.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.mkdocs.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.mkdocs.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"ResolvedNav": {
|
|
||||||
"name": "ResolvedNav",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.mkdocs.ResolvedNav",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('ResolvedNav', 'docforge.nav.resolver.ResolvedNav')>",
|
|
||||||
"docstring": "Resolved navigation structure.\n\nA ``ResolvedNav`` represents navigation data after glob patterns have been\nexpanded and paths validated against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page.\n groups: Mapping of navigation group titles to lists of resolved\n documentation file paths.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.mkdocs.ResolvedNav.home",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('home', 'docforge.nav.resolver.ResolvedNav.home')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.mkdocs.ResolvedNav.groups",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('groups', 'docforge.nav.resolver.ResolvedNav.groups')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"all_files": {
|
|
||||||
"name": "all_files",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.mkdocs.ResolvedNav.all_files",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('all_files', 'docforge.nav.resolver.ResolvedNav.all_files')>",
|
|
||||||
"docstring": "Iterate over all files referenced by the navigation structure.\n\nYields:\n Path:\n A documentation file referenced by the navigation, including\n the home page when defined.\n\nRaises:\n RuntimeError: If the home page is defined but the documentation\n root is not available for resolution."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MkDocsNavEmitter": {
|
|
||||||
"name": "MkDocsNavEmitter",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.mkdocs.MkDocsNavEmitter",
|
|
||||||
"signature": "<bound method Class.signature of Class('MkDocsNavEmitter', 23, 94)>",
|
|
||||||
"docstring": "Emit MkDocs navigation structures from resolved navigation data.\n\nThe emitter transforms a ``ResolvedNav`` object into the YAML-compatible\nlist structure expected by the MkDocs ``nav`` configuration field.",
|
|
||||||
"members": {
|
|
||||||
"emit": {
|
|
||||||
"name": "emit",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.mkdocs.MkDocsNavEmitter.emit",
|
|
||||||
"signature": "<bound method Function.signature of Function('emit', 31, 61)>",
|
|
||||||
"docstring": "Generate a navigation structure for ``mkdocs.yml``.\n\nArgs:\n nav (ResolvedNav):\n Resolved navigation data describing documentation groups\n and their associated Markdown files.\n\nReturns:\n list[dict[str, Any]]:\n A list of dictionaries representing the MkDocs navigation layout.\n Each dictionary maps a navigation label to a page or a list of\n pages."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,111 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.nav.resolver",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.nav.resolver",
|
|
||||||
"docstring": "Navigation resolution utilities.\n\nThis module resolves a ``NavSpec`` against the filesystem by expanding glob\npatterns and validating that referenced documentation files exist.\n\n---\n\nNotes:\n - Glob resolution is recursive and returns paths in sorted order.\n - Unmatched patterns raise ``FileNotFoundError`` to fail fast on typos.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"glob": {
|
|
||||||
"name": "glob",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.resolver.glob",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('glob', 'glob')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Iterable": {
|
|
||||||
"name": "Iterable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.resolver.Iterable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Iterable', 'collections.abc.Iterable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.resolver.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"NavSpec": {
|
|
||||||
"name": "NavSpec",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('NavSpec', 'docforge.nav.spec.NavSpec')>",
|
|
||||||
"docstring": "Parsed representation of a navigation specification.\n\nA ``NavSpec`` describes the intended documentation navigation layout before\nit is resolved against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page (for example\n ``index.md``).\n groups: Mapping of navigation group titles to lists of file patterns\n or glob expressions.\n icon: Optional mapping of theme icon entries (for example\n ``{\"logo\": \"material/code-tags\"}``) injected into the MkDocs\n theme as ``theme.icon``.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.home",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('home', 'docforge.nav.spec.NavSpec.home')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.groups",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('groups', 'docforge.nav.spec.NavSpec.groups')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"icon": {
|
|
||||||
"name": "icon",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.icon",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('icon', 'docforge.nav.spec.NavSpec.icon')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"load": {
|
|
||||||
"name": "load",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.load",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('load', 'docforge.nav.spec.NavSpec.load')>",
|
|
||||||
"docstring": "Load a navigation specification from a YAML file.\n\nArgs:\n path (Path):\n Filesystem path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed configuration.\n\nRaises:\n FileNotFoundError: If the specified file does not exist.\n ValueError: If the file contents are not a valid navigation\n specification."
|
|
||||||
},
|
|
||||||
"all_patterns": {
|
|
||||||
"name": "all_patterns",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolver.NavSpec.all_patterns",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('all_patterns', 'docforge.nav.spec.NavSpec.all_patterns')>",
|
|
||||||
"docstring": "Return all path patterns referenced by the specification.\n\nReturns:\n list[str]:\n A list containing the home document (if defined) and all\n group pattern entries."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"ResolvedNav": {
|
|
||||||
"name": "ResolvedNav",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.resolver.ResolvedNav",
|
|
||||||
"signature": "<bound method Class.signature of Class('ResolvedNav', 23, 76)>",
|
|
||||||
"docstring": "Resolved navigation structure.\n\nA ``ResolvedNav`` represents navigation data after glob patterns have been\nexpanded and paths validated against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page.\n groups: Mapping of navigation group titles to lists of resolved\n documentation file paths.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.ResolvedNav.home",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.resolver.ResolvedNav.groups",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"all_files": {
|
|
||||||
"name": "all_files",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolver.ResolvedNav.all_files",
|
|
||||||
"signature": "<bound method Function.signature of Function('all_files', 57, 76)>",
|
|
||||||
"docstring": "Iterate over all files referenced by the navigation structure.\n\nYields:\n Path:\n A documentation file referenced by the navigation, including\n the home page when defined.\n\nRaises:\n RuntimeError: If the home page is defined but the documentation\n root is not available for resolution."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"resolve_nav": {
|
|
||||||
"name": "resolve_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.resolver.resolve_nav",
|
|
||||||
"signature": "<bound method Function.signature of Function('resolve_nav', 79, 150)>",
|
|
||||||
"docstring": "Resolve a navigation specification against the filesystem.\n\nThe function expands glob patterns defined in a ``NavSpec`` and verifies\nthat referenced documentation files exist within the documentation root.\n\nArgs:\n spec (NavSpec):\n Navigation specification describing documentation layout.\n docs_root (Path):\n Root directory containing documentation Markdown files.\n\nReturns:\n ResolvedNav:\n A `ResolvedNav` instance containing validated navigation paths.\n\nRaises:\n FileNotFoundError: If the documentation root does not exist or a\n navigation pattern does not match any files."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.nav.spec",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.nav.spec",
|
|
||||||
"docstring": "Navigation specification model.\n\nThis module defines the ``NavSpec`` class, which represents the navigation\nstructure defined by the user in the doc-forge navigation specification\n(typically ``docforge.nav.yml``).\n\n---\n\nNotes:\n - The spec file supports an optional ``icon`` mapping for MkDocs theme\n customization.\n - All file references in ``groups`` are relative to the documentation root.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"annotations": {
|
|
||||||
"name": "annotations",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.spec.annotations",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('annotations', '__future__.annotations')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.spec.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"yaml": {
|
|
||||||
"name": "yaml",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.spec.yaml",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('yaml', 'yaml')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"NavSpec": {
|
|
||||||
"name": "NavSpec",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.nav.spec.NavSpec",
|
|
||||||
"signature": "<bound method Class.signature of Class('NavSpec', 25, 136)>",
|
|
||||||
"docstring": "Parsed representation of a navigation specification.\n\nA ``NavSpec`` describes the intended documentation navigation layout before\nit is resolved against the filesystem.\n\nAttributes:\n home: Relative path to the documentation home page (for example\n ``index.md``).\n groups: Mapping of navigation group titles to lists of file patterns\n or glob expressions.\n icon: Optional mapping of theme icon entries (for example\n ``{\"logo\": \"material/code-tags\"}``) injected into the MkDocs\n theme as ``theme.icon``.",
|
|
||||||
"members": {
|
|
||||||
"home": {
|
|
||||||
"name": "home",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.home",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"groups": {
|
|
||||||
"name": "groups",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.groups",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"icon": {
|
|
||||||
"name": "icon",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.icon",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"load": {
|
|
||||||
"name": "load",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.load",
|
|
||||||
"signature": "<bound method Function.signature of Function('load', 65, 117)>",
|
|
||||||
"docstring": "Load a navigation specification from a YAML file.\n\nArgs:\n path (Path):\n Filesystem path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed configuration.\n\nRaises:\n FileNotFoundError: If the specified file does not exist.\n ValueError: If the file contents are not a valid navigation\n specification."
|
|
||||||
},
|
|
||||||
"all_patterns": {
|
|
||||||
"name": "all_patterns",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.spec.NavSpec.all_patterns",
|
|
||||||
"signature": "<bound method Function.signature of Function('all_patterns', 119, 136)>",
|
|
||||||
"docstring": "Return all path patterns referenced by the specification.\n\nReturns:\n list[str]:\n A list containing the home document (if defined) and all\n group pattern entries."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"load_nav_spec": {
|
|
||||||
"name": "load_nav_spec",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.spec.load_nav_spec",
|
|
||||||
"signature": "<bound method Function.signature of Function('load_nav_spec', 139, 170)>",
|
|
||||||
"docstring": "Load a navigation specification file.\n\nThis helper function reads a YAML navigation file and constructs a\ncorresponding ``NavSpec`` instance.\n\nArgs:\n path (Path):\n Path to the navigation specification file.\n\nReturns:\n NavSpec:\n A ``NavSpec`` instance representing the parsed specification.\n\nRaises:\n FileNotFoundError: If the specification file does not exist.\n ValueError: If the YAML structure is invalid."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.nav.wiki",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.nav.wiki",
|
|
||||||
"docstring": "# Summary\n\nWiki navigation derivation.\n\nThis module provides ``build_wiki_nav``, which derives an MkDocs-ready\nnavigation block from the file structure of a hand-written wiki directory\n(typically ``docs/wiki``). wiki content is authored by hand and is never\nmodified by doc-forge; only the navigation layout is inferred.\n\n# Notes\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.",
|
|
||||||
"objects": {
|
|
||||||
"re": {
|
|
||||||
"name": "re",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.wiki.re",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('re', 're')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Callable": {
|
|
||||||
"name": "Callable",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.wiki.Callable",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Callable', 'collections.abc.Callable')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.wiki.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.nav.wiki.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"build_wiki_nav": {
|
|
||||||
"name": "build_wiki_nav",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.nav.wiki.build_wiki_nav",
|
|
||||||
"signature": "<bound method Function.signature of Function('build_wiki_nav', 28, 76)>",
|
|
||||||
"docstring": "Derive an MkDocs navigation block from a wiki directory.\n\nReturned paths are relative to the parent of ``wiki_dir`` and carry the\nwiki directory name as their leading component (for example\n``wiki/01_overview.md`` when the wiki lives at ``docs/wiki``). This makes\nthe result directly usable in an MkDocs ``nav`` block with\n\n- ``index.md`` at the wiki root becomes the ``Home`` entry.\n- Page labels are derived from filenames: numeric order prefixes such as\n ``01_`` or ``02-`` are stripped, separators are replaced with spaces, and\n names are title-cased (``01_overview.md`` becomes ``Overview``).\n- Subdirectories become nested navigation groups. A nested ``index.md`` is\n rendered as the section root placed first inside the group.\n- Only ``.md`` files are considered; hidden entries are ignored.\n\nArgs:\n wiki_dir (Path):\n Path to the hand-written wiki directory, for example ``docs/wiki``.\n\nReturns:\n list[dict[str, Any]]:\n Navigation entries compatible with the MkDocs ``nav`` configuration.\n The list is empty if the wiki contains no Markdown files.\n\nRaises:\n FileNotFoundError:\n If the wiki directory does not exist."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.renderers.base",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.renderers.base",
|
|
||||||
"docstring": "# Summary\n\nRenderer base interfaces and configuration models.\n\nThis module defines the base protocol and configuration container used by\ndoc-forge renderers. Concrete renderer implementations should implement the\n`DocRenderer` protocol.",
|
|
||||||
"objects": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.base.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Protocol": {
|
|
||||||
"name": "Protocol",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.base.Protocol",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Protocol', 'typing.Protocol')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.base.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"RendererConfig": {
|
|
||||||
"name": "RendererConfig",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.base.RendererConfig",
|
|
||||||
"signature": "<bound method Class.signature of Class('RendererConfig', 17, 44)>",
|
|
||||||
"docstring": "Configuration container for documentation renderers.\n\nA `RendererConfig` instance groups together the project model and the\noutput directory used during rendering.\n\nAttributes:\n out_dir (Path):\n Directory where generated documentation files will be written.\n\n project (Project):\n Documentation project model to be rendered.",
|
|
||||||
"members": {
|
|
||||||
"out_dir": {
|
|
||||||
"name": "out_dir",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.RendererConfig.out_dir",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"project": {
|
|
||||||
"name": "project",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.RendererConfig.project",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"DocRenderer": {
|
|
||||||
"name": "DocRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.base.DocRenderer",
|
|
||||||
"signature": "<bound method Class.signature of Class('DocRenderer', 47, 72)>",
|
|
||||||
"docstring": "Protocol defining the interface for documentation renderers.\n\nImplementations of this protocol are responsible for transforming a\n`Project` model into renderer-specific documentation sources.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.DocRenderer.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.DocRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_sources', 57, 72)>",
|
|
||||||
"docstring": "Generate renderer-specific documentation sources.\n\nArgs:\n project (Project):\n Project model containing modules and documentation objects.\n\n out_dir (Path):\n Directory where generated documentation sources should be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,557 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.renderers",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.renderers",
|
|
||||||
"docstring": "# Summary\n\nRenderers layer for doc-forge.\n\nThe `docforge.renderers` package transforms the internal documentation\nmodels into files formatted for specific documentation systems.\n\n---\n\n# Overview\n\nRenderers consume the doc-forge project model and generate output suitable\nfor documentation tools or machine interfaces.\n\nCurrent implementations:\n\n- **MkDocsRenderer** – Produces Markdown files compatible with MkDocs and\n the `mkdocstrings` plugin. It automatically handles package hierarchy\n and generates `index.md` files for packages.\n- **MCPRenderer** – Emits structured JSON resources designed for consumption\n by Model Context Protocol (MCP) clients.\n\n---\n\n# Extending\n\nNew renderers can be added by implementing the `DocRenderer` protocol\ndefined in `docforge.renderers.base`.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"MkDocsRenderer": {
|
|
||||||
"name": "MkDocsRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.MkDocsRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MkDocsRenderer', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer')>",
|
|
||||||
"docstring": "Renderer that produces Markdown documentation for MkDocs.\n\nGenerated pages use mkdocstrings directives to reference Python modules,\nallowing MkDocs to render API documentation dynamically.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.MkDocsRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.MkDocsRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate Markdown documentation files for a project.\n\nThis method renders a documentation structure from the provided\nproject model and writes the resulting Markdown files to the\nspecified output directory.\n\nArgs:\n project (Project):\n Project model containing modules to document.\n\n out_dir (Path):\n Directory where generated Markdown files will be written.\n\n module_is_source (bool | None):\n If True, treat the specified module as the documentation root\n rather than nesting it inside a folder."
|
|
||||||
},
|
|
||||||
"generate_readme": {
|
|
||||||
"name": "generate_readme",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.MkDocsRenderer.generate_readme",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_readme', 'docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme')>",
|
|
||||||
"docstring": "Generate a `README.md` file from the root module docstring.\n\nNotes:\n - If `module_is_source` is True, `README.md` is written to the\n project root directory.\n - If False, README generation is currently not implemented.\n\nArgs:\n project (Project):\n Project model containing documentation metadata.\n\n docs_dir (Path):\n Directory containing generated documentation sources.\n\n module_is_source (bool | None):\n Whether the module is treated as the project source root.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written.\n Defaults to the parent of `docs_dir`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MCPRenderer": {
|
|
||||||
"name": "MCPRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.MCPRenderer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPRenderer', 'docforge.renderers.mcp_renderer.MCPRenderer')>",
|
|
||||||
"docstring": "Renderer that generates MCP-compatible documentation resources.\n\nThis renderer converts doc-forge project models into structured JSON\nresources suitable for consumption by systems implementing the Model\nContext Protocol (MCP).",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.MCPRenderer.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.renderers.mcp_renderer.MCPRenderer.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.MCPRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mcp_renderer.MCPRenderer.generate_sources')>",
|
|
||||||
"docstring": "Generate MCP documentation resources for a project.\n\nThe renderer serializes each module into a JSON resource and produces\nsupporting metadata files such as `nav.json` and `index.json`.\n\nArgs:\n project (Project):\n Documentation project model to render.\n\n out_dir (Path):\n Directory where MCP resources will be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"base": {
|
|
||||||
"name": "base",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.renderers.base",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nRenderer base interfaces and configuration models.\n\nThis module defines the base protocol and configuration container used by\ndoc-forge renderers. Concrete renderer implementations should implement the\n`DocRenderer` protocol.",
|
|
||||||
"members": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.base.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Protocol": {
|
|
||||||
"name": "Protocol",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.base.Protocol",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Protocol', 'typing.Protocol')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.base.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"RendererConfig": {
|
|
||||||
"name": "RendererConfig",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.base.RendererConfig",
|
|
||||||
"signature": "<bound method Class.signature of Class('RendererConfig', 17, 44)>",
|
|
||||||
"docstring": "Configuration container for documentation renderers.\n\nA `RendererConfig` instance groups together the project model and the\noutput directory used during rendering.\n\nAttributes:\n out_dir (Path):\n Directory where generated documentation files will be written.\n\n project (Project):\n Documentation project model to be rendered.",
|
|
||||||
"members": {
|
|
||||||
"out_dir": {
|
|
||||||
"name": "out_dir",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.RendererConfig.out_dir",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"project": {
|
|
||||||
"name": "project",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.RendererConfig.project",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"DocRenderer": {
|
|
||||||
"name": "DocRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.base.DocRenderer",
|
|
||||||
"signature": "<bound method Class.signature of Class('DocRenderer', 47, 72)>",
|
|
||||||
"docstring": "Protocol defining the interface for documentation renderers.\n\nImplementations of this protocol are responsible for transforming a\n`Project` model into renderer-specific documentation sources.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.base.DocRenderer.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.base.DocRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_sources', 57, 72)>",
|
|
||||||
"docstring": "Generate renderer-specific documentation sources.\n\nArgs:\n project (Project):\n Project model containing modules and documentation objects.\n\n out_dir (Path):\n Directory where generated documentation sources should be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mcp_renderer": {
|
|
||||||
"name": "mcp_renderer",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.renderers.mcp_renderer",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nMCP renderer implementation.\n\nThis module defines the `MCPRenderer` class, which generates documentation\nresources compatible with the Model Context Protocol (MCP).",
|
|
||||||
"members": {
|
|
||||||
"json": {
|
|
||||||
"name": "json",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.json",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('json', 'json')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MCPRenderer": {
|
|
||||||
"name": "MCPRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer",
|
|
||||||
"signature": "<bound method Class.signature of Class('MCPRenderer', 16, 159)>",
|
|
||||||
"docstring": "Renderer that generates MCP-compatible documentation resources.\n\nThis renderer converts doc-forge project models into structured JSON\nresources suitable for consumption by systems implementing the Model\nContext Protocol (MCP).",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_sources', 27, 73)>",
|
|
||||||
"docstring": "Generate MCP documentation resources for a project.\n\nThe renderer serializes each module into a JSON resource and produces\nsupporting metadata files such as `nav.json` and `index.json`.\n\nArgs:\n project (Project):\n Documentation project model to render.\n\n out_dir (Path):\n Directory where MCP resources will be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mkdocs_renderer": {
|
|
||||||
"name": "mkdocs_renderer",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nMkDocs renderer implementation.\n\nThis module defines the `MkDocsRenderer` class, which generates Markdown\ndocumentation sources compatible with MkDocs Material and the mkdocstrings\nplugin.\n\nThe renderer ensures a consistent documentation structure by:\n\n- Creating a root `index.md` if one does not exist\n- Generating package index pages automatically\n- Linking child modules within parent package pages\n- Optionally generating `README.md` from the root package docstring",
|
|
||||||
"members": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MkDocsRenderer": {
|
|
||||||
"name": "MkDocsRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer",
|
|
||||||
"signature": "<bound method Class.signature of Class('MkDocsRenderer', 23, 306)>",
|
|
||||||
"docstring": "Renderer that produces Markdown documentation for MkDocs.\n\nGenerated pages use mkdocstrings directives to reference Python modules,\nallowing MkDocs to render API documentation dynamically.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_sources', 37, 78)>",
|
|
||||||
"docstring": "Generate Markdown documentation files for a project.\n\nThis method renders a documentation structure from the provided\nproject model and writes the resulting Markdown files to the\nspecified output directory.\n\nArgs:\n project (Project):\n Project model containing modules to document.\n\n out_dir (Path):\n Directory where generated Markdown files will be written.\n\n module_is_source (bool | None):\n If True, treat the specified module as the documentation root\n rather than nesting it inside a folder."
|
|
||||||
},
|
|
||||||
"generate_readme": {
|
|
||||||
"name": "generate_readme",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_readme', 80, 144)>",
|
|
||||||
"docstring": "Generate a `README.md` file from the root module docstring.\n\nNotes:\n - If `module_is_source` is True, `README.md` is written to the\n project root directory.\n - If False, README generation is currently not implemented.\n\nArgs:\n project (Project):\n Project model containing documentation metadata.\n\n docs_dir (Path):\n Directory containing generated documentation sources.\n\n module_is_source (bool | None):\n Whether the module is treated as the project source root.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written.\n Defaults to the parent of `docs_dir`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,227 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.renderers.mcp_renderer",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.renderers.mcp_renderer",
|
|
||||||
"docstring": "# Summary\n\nMCP renderer implementation.\n\nThis module defines the `MCPRenderer` class, which generates documentation\nresources compatible with the Model Context Protocol (MCP).",
|
|
||||||
"objects": {
|
|
||||||
"json": {
|
|
||||||
"name": "json",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.json",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('json', 'json')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"DocObject": {
|
|
||||||
"name": "DocObject",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('DocObject', 'docforge.models.DocObject')>",
|
|
||||||
"docstring": "Representation of a documented Python object.\n\nA `DocObject` models a single Python entity discovered during\nintrospection. Objects may contain nested members, allowing the structure\nof modules, classes, and other containers to be represented recursively.\n\nAttributes:\n name (str):\n Local name of the object.\n\n kind (str):\n Type of object (for example `class`, `function`, `method`, or `attribute`).\n\n path (str):\n Fully qualified dotted path to the object.\n\n signature (str | None):\n Callable signature if the object represents a callable.\n\n docstring (str | None):\n Raw docstring text extracted from the source code.\n\n members (dict[str, DocObject]):\n Mapping of member names to child `DocObject` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.object.DocObject.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"kind": {
|
|
||||||
"name": "kind",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.kind",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('kind', 'docforge.models.object.DocObject.kind')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.object.DocObject.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"signature": {
|
|
||||||
"name": "signature",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.signature",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('signature', 'docforge.models.object.DocObject.signature')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.object.DocObject.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.object.DocObject.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_member": {
|
|
||||||
"name": "add_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.add_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_member', 'docforge.models.object.DocObject.add_member')>",
|
|
||||||
"docstring": "Add a child documentation object.\n\nThis is typically used when attaching methods to classes or\nnested objects to their parent containers.\n\nArgs:\n obj (DocObject):\n Documentation object to add as a member."
|
|
||||||
},
|
|
||||||
"get_member": {
|
|
||||||
"name": "get_member",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.get_member",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_member', 'docforge.models.object.DocObject.get_member')>",
|
|
||||||
"docstring": "Retrieve a member object by name.\n\nArgs:\n name (str):\n Name of the member to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If the member does not exist."
|
|
||||||
},
|
|
||||||
"get_all_members": {
|
|
||||||
"name": "get_all_members",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.DocObject.get_all_members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_members', 'docforge.models.object.DocObject.get_all_members')>",
|
|
||||||
"docstring": "Return all child members of the object.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing nested members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MCPRenderer": {
|
|
||||||
"name": "MCPRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer",
|
|
||||||
"signature": "<bound method Class.signature of Class('MCPRenderer', 16, 159)>",
|
|
||||||
"docstring": "Renderer that generates MCP-compatible documentation resources.\n\nThis renderer converts doc-forge project models into structured JSON\nresources suitable for consumption by systems implementing the Model\nContext Protocol (MCP).",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_sources', 27, 73)>",
|
|
||||||
"docstring": "Generate MCP documentation resources for a project.\n\nThe renderer serializes each module into a JSON resource and produces\nsupporting metadata files such as `nav.json` and `index.json`.\n\nArgs:\n project (Project):\n Documentation project model to render.\n\n out_dir (Path):\n Directory where MCP resources will be written."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.mcp_renderer.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,148 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.renderers.mkdocs_renderer",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer",
|
|
||||||
"docstring": "# Summary\n\nMkDocs renderer implementation.\n\nThis module defines the `MkDocsRenderer` class, which generates Markdown\ndocumentation sources compatible with MkDocs Material and the mkdocstrings\nplugin.\n\nThe renderer ensures a consistent documentation structure by:\n\n- Creating a root `index.md` if one does not exist\n- Generating package index pages automatically\n- Linking child modules within parent package pages\n- Optionally generating `README.md` from the root package docstring",
|
|
||||||
"objects": {
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Module": {
|
|
||||||
"name": "Module",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Module', 'docforge.models.Module')>",
|
|
||||||
"docstring": "Representation of a documented Python module or package.\n\nA `Module` stores metadata about the module itself and maintains a\ncollection of top-level documentation objects discovered during\nintrospection.\n\nAttributes:\n path (str):\n Dotted import path of the module.\n\n docstring (str | None):\n Module-level documentation string, if present.\n\n members (dict[str, DocObject]):\n Mapping of object names to their corresponding `DocObject` representations.",
|
|
||||||
"members": {
|
|
||||||
"path": {
|
|
||||||
"name": "path",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('path', 'docforge.models.module.Module.path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"docstring": {
|
|
||||||
"name": "docstring",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.docstring",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('docstring', 'docforge.models.module.Module.docstring')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"members": {
|
|
||||||
"name": "members",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.members",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('members', 'docforge.models.module.Module.members')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_object": {
|
|
||||||
"name": "add_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.add_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_object', 'docforge.models.module.Module.add_object')>",
|
|
||||||
"docstring": "Add a documented object to the module.\n\nArgs:\n obj (DocObject):\n Documentation object to register as a top-level member of the module."
|
|
||||||
},
|
|
||||||
"get_object": {
|
|
||||||
"name": "get_object",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.get_object",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_object', 'docforge.models.module.Module.get_object')>",
|
|
||||||
"docstring": "Retrieve a documented object by name.\n\nArgs:\n name (str):\n Name of the object to retrieve.\n\nReturns:\n DocObject:\n The corresponding `DocObject` instance.\n\nRaises:\n KeyError:\n If no object with the given name exists."
|
|
||||||
},
|
|
||||||
"get_all_objects": {
|
|
||||||
"name": "get_all_objects",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Module.get_all_objects",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_objects', 'docforge.models.module.Module.get_all_objects')>",
|
|
||||||
"docstring": "Return all top-level documentation objects in the module.\n\nReturns:\n Iterable[DocObject]:\n An iterable of `DocObject` instances representing the module's public members."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Project": {
|
|
||||||
"name": "Project",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Project', 'docforge.models.Project')>",
|
|
||||||
"docstring": "Representation of a documentation project.\n\nA `Project` serves as the root container for all modules discovered during\nintrospection. Each module is stored by its dotted import path.\n\nAttributes:\n name (str):\n Name of the project.\n\n modules (dict[str, Module]):\n Mapping of module paths to `Module` instances.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.name",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('name', 'docforge.models.project.Project.name')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"modules": {
|
|
||||||
"name": "modules",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('modules', 'docforge.models.project.Project.modules')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"add_module": {
|
|
||||||
"name": "add_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.add_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('add_module', 'docforge.models.project.Project.add_module')>",
|
|
||||||
"docstring": "Register a module in the project.\n\nArgs:\n module (Module):\n Module instance to add to the project."
|
|
||||||
},
|
|
||||||
"get_module": {
|
|
||||||
"name": "get_module",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.get_module",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module', 'docforge.models.project.Project.get_module')>",
|
|
||||||
"docstring": "Retrieve a module by its dotted path.\n\nArgs:\n path (str):\n Fully qualified dotted module path (for example `pkg.module`).\n\nReturns:\n Module:\n The corresponding `Module` instance.\n\nRaises:\n KeyError:\n If the module does not exist in the project."
|
|
||||||
},
|
|
||||||
"get_all_modules": {
|
|
||||||
"name": "get_all_modules",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.get_all_modules",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_all_modules', 'docforge.models.project.Project.get_all_modules')>",
|
|
||||||
"docstring": "Return all modules contained in the project.\n\nReturns:\n Iterable[Module]:\n An iterable of `Module` instances."
|
|
||||||
},
|
|
||||||
"get_module_list": {
|
|
||||||
"name": "get_module_list",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.Project.get_module_list",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('get_module_list', 'docforge.models.project.Project.get_module_list')>",
|
|
||||||
"docstring": "Return the list of module import paths.\n\nReturns:\n list[str]:\n A list containing the dotted paths of all modules in the project."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"MkDocsRenderer": {
|
|
||||||
"name": "MkDocsRenderer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer",
|
|
||||||
"signature": "<bound method Class.signature of Class('MkDocsRenderer', 23, 306)>",
|
|
||||||
"docstring": "Renderer that produces Markdown documentation for MkDocs.\n\nGenerated pages use mkdocstrings directives to reference Python modules,\nallowing MkDocs to render API documentation dynamically.",
|
|
||||||
"members": {
|
|
||||||
"name": {
|
|
||||||
"name": "name",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.name",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"generate_sources": {
|
|
||||||
"name": "generate_sources",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_sources', 37, 78)>",
|
|
||||||
"docstring": "Generate Markdown documentation files for a project.\n\nThis method renders a documentation structure from the provided\nproject model and writes the resulting Markdown files to the\nspecified output directory.\n\nArgs:\n project (Project):\n Project model containing modules to document.\n\n out_dir (Path):\n Directory where generated Markdown files will be written.\n\n module_is_source (bool | None):\n If True, treat the specified module as the documentation root\n rather than nesting it inside a folder."
|
|
||||||
},
|
|
||||||
"generate_readme": {
|
|
||||||
"name": "generate_readme",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_readme",
|
|
||||||
"signature": "<bound method Function.signature of Function('generate_readme', 80, 144)>",
|
|
||||||
"docstring": "Generate a `README.md` file from the root module docstring.\n\nNotes:\n - If `module_is_source` is True, `README.md` is written to the\n project root directory.\n - If False, README generation is currently not implemented.\n\nArgs:\n project (Project):\n Project model containing documentation metadata.\n\n docs_dir (Path):\n Directory containing generated documentation sources.\n\n module_is_source (bool | None):\n Whether the module is treated as the project source root.\n\n readme_dir (Path | None):\n Directory where the generated README.md should be written.\n Defaults to the parent of `docs_dir`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.servers",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.servers",
|
|
||||||
"docstring": "# Summary\n\nServer layer for doc-forge.\n\nThis module exposes server implementations used to provide live access\nto generated documentation resources. Currently, it includes the MCP\ndocumentation server.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"MCPServer": {
|
|
||||||
"name": "MCPServer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.servers.MCPServer",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('MCPServer', 'docforge.servers.mcp_server.MCPServer')>",
|
|
||||||
"docstring": "MCP server for serving a pre-generated documentation bundle.\n\nThe server exposes documentation resources and diagnostic tools through\nMCP endpoints backed by JSON files generated by the MCP renderer.\n\nAttributes:\n mcp_root (Path):\n Directory containing the generated MCP documentation bundle.\n\n app (FastMCP):\n Underlying FastMCP application instance that registers resources\n and tools.",
|
|
||||||
"members": {
|
|
||||||
"mcp_root": {
|
|
||||||
"name": "mcp_root",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.servers.MCPServer.mcp_root",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('mcp_root', 'docforge.servers.mcp_server.MCPServer.mcp_root')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"app": {
|
|
||||||
"name": "app",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.servers.MCPServer.app",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('app', 'docforge.servers.mcp_server.MCPServer.app')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"run": {
|
|
||||||
"name": "run",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.servers.MCPServer.run",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('run', 'docforge.servers.mcp_server.MCPServer.run')>",
|
|
||||||
"docstring": "Start the MCP server.\n\nArgs:\n transport (Literal[\"stdio\", \"sse\", \"streamable-http\"]):\n Transport mechanism used by the MCP server. Supported options\n include `stdio`, `sse`, and `streamable-http`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mcp_server": {
|
|
||||||
"name": "mcp_server",
|
|
||||||
"kind": "module",
|
|
||||||
"path": "docforge.servers.mcp_server",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": "# Summary\n\nMCP server implementation.\n\nThis module defines the `MCPServer` class, which serves pre-generated\ndocumentation bundles through the Model Context Protocol (MCP).\n\n---\n\nNotes:\n - The served bundle is generated offline by `MCPRenderer`.\n - Missing resources are reported as structured error dictionaries rather\n than raising exceptions.\n - The server exposes read-only resources and a single health-check tool.\n\n---",
|
|
||||||
"members": {
|
|
||||||
"annotations": {
|
|
||||||
"name": "annotations",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.annotations",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('annotations', '__future__.annotations')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"json": {
|
|
||||||
"name": "json",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.json",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('json', 'json')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Literal": {
|
|
||||||
"name": "Literal",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.Literal",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Literal', 'typing.Literal')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"FastMCP": {
|
|
||||||
"name": "FastMCP",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.FastMCP",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('FastMCP', 'mcp.server.fastmcp.FastMCP')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"MCPServer": {
|
|
||||||
"name": "MCPServer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.servers.mcp_server.MCPServer",
|
|
||||||
"signature": "<bound method Class.signature of Class('MCPServer', 29, 152)>",
|
|
||||||
"docstring": "MCP server for serving a pre-generated documentation bundle.\n\nThe server exposes documentation resources and diagnostic tools through\nMCP endpoints backed by JSON files generated by the MCP renderer.\n\nAttributes:\n mcp_root (Path):\n Directory containing the generated MCP documentation bundle.\n\n app (FastMCP):\n Underlying FastMCP application instance that registers resources\n and tools.",
|
|
||||||
"members": {
|
|
||||||
"mcp_root": {
|
|
||||||
"name": "mcp_root",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.servers.mcp_server.MCPServer.mcp_root",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"app": {
|
|
||||||
"name": "app",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.servers.mcp_server.MCPServer.app",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"run": {
|
|
||||||
"name": "run",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.servers.mcp_server.MCPServer.run",
|
|
||||||
"signature": "<bound method Function.signature of Function('run', 140, 152)>",
|
|
||||||
"docstring": "Start the MCP server.\n\nArgs:\n transport (Literal[\"stdio\", \"sse\", \"streamable-http\"]):\n Transport mechanism used by the MCP server. Supported options\n include `stdio`, `sse`, and `streamable-http`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "docforge.servers.mcp_server",
|
|
||||||
"content": {
|
|
||||||
"path": "docforge.servers.mcp_server",
|
|
||||||
"docstring": "# Summary\n\nMCP server implementation.\n\nThis module defines the `MCPServer` class, which serves pre-generated\ndocumentation bundles through the Model Context Protocol (MCP).\n\n---\n\nNotes:\n - The served bundle is generated offline by `MCPRenderer`.\n - Missing resources are reported as structured error dictionaries rather\n than raising exceptions.\n - The server exposes read-only resources and a single health-check tool.\n\n---",
|
|
||||||
"objects": {
|
|
||||||
"annotations": {
|
|
||||||
"name": "annotations",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.annotations",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('annotations', '__future__.annotations')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"json": {
|
|
||||||
"name": "json",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.json",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('json', 'json')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Path": {
|
|
||||||
"name": "Path",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.Path",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Any": {
|
|
||||||
"name": "Any",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.Any",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"Literal": {
|
|
||||||
"name": "Literal",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.Literal",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('Literal', 'typing.Literal')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"FastMCP": {
|
|
||||||
"name": "FastMCP",
|
|
||||||
"kind": "alias",
|
|
||||||
"path": "docforge.servers.mcp_server.FastMCP",
|
|
||||||
"signature": "<bound method Alias.signature of Alias('FastMCP', 'mcp.server.fastmcp.FastMCP')>",
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"MCPServer": {
|
|
||||||
"name": "MCPServer",
|
|
||||||
"kind": "class",
|
|
||||||
"path": "docforge.servers.mcp_server.MCPServer",
|
|
||||||
"signature": "<bound method Class.signature of Class('MCPServer', 29, 152)>",
|
|
||||||
"docstring": "MCP server for serving a pre-generated documentation bundle.\n\nThe server exposes documentation resources and diagnostic tools through\nMCP endpoints backed by JSON files generated by the MCP renderer.\n\nAttributes:\n mcp_root (Path):\n Directory containing the generated MCP documentation bundle.\n\n app (FastMCP):\n Underlying FastMCP application instance that registers resources\n and tools.",
|
|
||||||
"members": {
|
|
||||||
"mcp_root": {
|
|
||||||
"name": "mcp_root",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.servers.mcp_server.MCPServer.mcp_root",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"app": {
|
|
||||||
"name": "app",
|
|
||||||
"kind": "attribute",
|
|
||||||
"path": "docforge.servers.mcp_server.MCPServer.app",
|
|
||||||
"signature": null,
|
|
||||||
"docstring": null
|
|
||||||
},
|
|
||||||
"run": {
|
|
||||||
"name": "run",
|
|
||||||
"kind": "function",
|
|
||||||
"path": "docforge.servers.mcp_server.MCPServer.run",
|
|
||||||
"signature": "<bound method Function.signature of Function('run', 140, 152)>",
|
|
||||||
"docstring": "Start the MCP server.\n\nArgs:\n transport (Literal[\"stdio\", \"sse\", \"streamable-http\"]):\n Transport mechanism used by the MCP server. Supported options\n include `stdio`, `sse`, and `streamable-http`."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,98 +0,0 @@
|
|||||||
[
|
|
||||||
{
|
|
||||||
"module": "docforge",
|
|
||||||
"resource": "docs://modules/docforge"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.cli",
|
|
||||||
"resource": "docs://modules/docforge.cli"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.cli.api_utils",
|
|
||||||
"resource": "docs://modules/docforge.cli.api_utils"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.cli.commands",
|
|
||||||
"resource": "docs://modules/docforge.cli.commands"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.cli.main",
|
|
||||||
"resource": "docs://modules/docforge.cli.main"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.cli.mcp_utils",
|
|
||||||
"resource": "docs://modules/docforge.cli.mcp_utils"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.cli.mkdocs_utils",
|
|
||||||
"resource": "docs://modules/docforge.cli.mkdocs_utils"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.loaders",
|
|
||||||
"resource": "docs://modules/docforge.loaders"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.loaders.griffe_loader",
|
|
||||||
"resource": "docs://modules/docforge.loaders.griffe_loader"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.models",
|
|
||||||
"resource": "docs://modules/docforge.models"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.models.module",
|
|
||||||
"resource": "docs://modules/docforge.models.module"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.models.object",
|
|
||||||
"resource": "docs://modules/docforge.models.object"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.models.project",
|
|
||||||
"resource": "docs://modules/docforge.models.project"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.nav",
|
|
||||||
"resource": "docs://modules/docforge.nav"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.nav.mkdocs",
|
|
||||||
"resource": "docs://modules/docforge.nav.mkdocs"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.nav.resolver",
|
|
||||||
"resource": "docs://modules/docforge.nav.resolver"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.nav.spec",
|
|
||||||
"resource": "docs://modules/docforge.nav.spec"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.nav.wiki",
|
|
||||||
"resource": "docs://modules/docforge.nav.wiki"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.renderers",
|
|
||||||
"resource": "docs://modules/docforge.renderers"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.renderers.base",
|
|
||||||
"resource": "docs://modules/docforge.renderers.base"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.renderers.mcp_renderer",
|
|
||||||
"resource": "docs://modules/docforge.renderers.mcp_renderer"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.renderers.mkdocs_renderer",
|
|
||||||
"resource": "docs://modules/docforge.renderers.mkdocs_renderer"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.servers",
|
|
||||||
"resource": "docs://modules/docforge.servers"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"module": "docforge.servers.mcp_server",
|
|
||||||
"resource": "docs://modules/docforge.servers.mcp_server"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user