aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
docs/libs/doc-forge/site/docforge/index.html
Vishesh 'ironeagle' Bangotra 24ecde4222
All checks were successful
continuous-integration/drone/push Build is passing
Details
added more libs
2026-01-22 17:20:17 +05:30

2145 lines
45 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="next" href="loaders/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Home - docforge</title>
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="../assets/_mkdocstrings.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>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#docforge_1" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
docforge
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Home
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan" aria-hidden="true" type="radio" name="__palette" id="__palette_0">
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="loaders/" class="md-tabs__link">
Loaders
</a>
</li>
<li class="md-tabs__item">
<a href="models/" class="md-tabs__link">
Models
</a>
</li>
<li class="md-tabs__item">
<a href="nav/" class="md-tabs__link">
Navigation
</a>
</li>
<li class="md-tabs__item">
<a href="renderers/" class="md-tabs__link">
Renderers
</a>
</li>
<li class="md-tabs__item">
<a href="cli/" class="md-tabs__link">
CLI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
docforge
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Home
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Home
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#docforge" class="md-nav__link">
<span class="md-ellipsis">
docforge
</span>
</a>
<nav class="md-nav" aria-label="docforge">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge--doc-forge" class="md-nav__link">
<span class="md-ellipsis">
doc-forge
</span>
</a>
<nav class="md-nav" aria-label="doc-forge">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge--available-commands" class="md-nav__link">
<span class="md-ellipsis">
Available Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge--installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge--quick-start" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge--build-mcp-resources" class="md-nav__link">
<span class="md-ellipsis">
Build MCP resources
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge--serve-mcp-documentation" class="md-nav__link">
<span class="md-ellipsis">
Serve MCP documentation
</span>
</a>
<nav class="md-nav" aria-label="Serve MCP documentation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge--project-structure" class="md-nav__link">
<span class="md-ellipsis">
Project Structure
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.GriffeLoader" class="md-nav__link">
<span class="md-ellipsis">
GriffeLoader
</span>
</a>
<nav class="md-nav" aria-label="GriffeLoader">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.GriffeLoader.load_module" class="md-nav__link">
<span class="md-ellipsis">
load_module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.GriffeLoader.load_project" class="md-nav__link">
<span class="md-ellipsis">
load_project
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.MCPRenderer" class="md-nav__link">
<span class="md-ellipsis">
MCPRenderer
</span>
</a>
<nav class="md-nav" aria-label="MCPRenderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.MCPRenderer.generate_sources" class="md-nav__link">
<span class="md-ellipsis">
generate_sources
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.MkDocsRenderer" class="md-nav__link">
<span class="md-ellipsis">
MkDocsRenderer
</span>
</a>
<nav class="md-nav" aria-label="MkDocsRenderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.MkDocsRenderer.generate_sources" class="md-nav__link">
<span class="md-ellipsis">
generate_sources
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.discover_module_paths" class="md-nav__link">
<span class="md-ellipsis">
discover_module_paths
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Loaders
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Loaders
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="loaders/" class="md-nav__link">
<span class="md-ellipsis">
Loaders
</span>
</a>
</li>
<li class="md-nav__item">
<a href="loaders/griffe_loader/" class="md-nav__link">
<span class="md-ellipsis">
Griffe Loader
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Models
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Models
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="models/" class="md-nav__link">
<span class="md-ellipsis">
Models
</span>
</a>
</li>
<li class="md-nav__item">
<a href="models/module/" class="md-nav__link">
<span class="md-ellipsis">
Module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="models/object/" class="md-nav__link">
<span class="md-ellipsis">
Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="models/project/" class="md-nav__link">
<span class="md-ellipsis">
Project
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Navigation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Navigation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="nav/" class="md-nav__link">
<span class="md-ellipsis">
Nav
</span>
</a>
</li>
<li class="md-nav__item">
<a href="nav/spec/" class="md-nav__link">
<span class="md-ellipsis">
Spec
</span>
</a>
</li>
<li class="md-nav__item">
<a href="nav/resolver/" class="md-nav__link">
<span class="md-ellipsis">
Resolver
</span>
</a>
</li>
<li class="md-nav__item">
<a href="nav/mkdocs/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Renderers
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Renderers
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="renderers/" class="md-nav__link">
<span class="md-ellipsis">
Renderers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="renderers/base/" class="md-nav__link">
<span class="md-ellipsis">
Base
</span>
</a>
</li>
<li class="md-nav__item">
<a href="renderers/mkdocs_renderer/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs Renderer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="renderers/mcp_renderer/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Renderer
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--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="0">
<span class="md-ellipsis">
CLI
</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>
CLI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="cli/" class="md-nav__link">
<span class="md-ellipsis">
Cli
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/main/" class="md-nav__link">
<span class="md-ellipsis">
Main
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/commands/" class="md-nav__link">
<span class="md-ellipsis">
Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/mcp_utils/" class="md-nav__link">
<span class="md-ellipsis">
Mcp Utils
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/mkdocs_utils/" class="md-nav__link">
<span class="md-ellipsis">
Mkdocs Utils
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#docforge" class="md-nav__link">
<span class="md-ellipsis">
docforge
</span>
</a>
<nav class="md-nav" aria-label="docforge">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge--doc-forge" class="md-nav__link">
<span class="md-ellipsis">
doc-forge
</span>
</a>
<nav class="md-nav" aria-label="doc-forge">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge--available-commands" class="md-nav__link">
<span class="md-ellipsis">
Available Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge--installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge--quick-start" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge--build-mcp-resources" class="md-nav__link">
<span class="md-ellipsis">
Build MCP resources
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge--serve-mcp-documentation" class="md-nav__link">
<span class="md-ellipsis">
Serve MCP documentation
</span>
</a>
<nav class="md-nav" aria-label="Serve MCP documentation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge--project-structure" class="md-nav__link">
<span class="md-ellipsis">
Project Structure
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.GriffeLoader" class="md-nav__link">
<span class="md-ellipsis">
GriffeLoader
</span>
</a>
<nav class="md-nav" aria-label="GriffeLoader">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.GriffeLoader.load_module" class="md-nav__link">
<span class="md-ellipsis">
load_module
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docforge.GriffeLoader.load_project" class="md-nav__link">
<span class="md-ellipsis">
load_project
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.MCPRenderer" class="md-nav__link">
<span class="md-ellipsis">
MCPRenderer
</span>
</a>
<nav class="md-nav" aria-label="MCPRenderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.MCPRenderer.generate_sources" class="md-nav__link">
<span class="md-ellipsis">
generate_sources
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.MkDocsRenderer" class="md-nav__link">
<span class="md-ellipsis">
MkDocsRenderer
</span>
</a>
<nav class="md-nav" aria-label="MkDocsRenderer">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docforge.MkDocsRenderer.generate_sources" class="md-nav__link">
<span class="md-ellipsis">
generate_sources
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#docforge.discover_module_paths" class="md-nav__link">
<span class="md-ellipsis">
discover_module_paths
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="docforge_1">Docforge</h1>
<div class="doc doc-object doc-module">
<h2 id="docforge" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">docforge</span>
</h2>
<div class="doc doc-contents first">
<h3 id="docforge--doc-forge">doc-forge</h3>
<p><code>doc-forge</code> is a renderer-agnostic Python documentation compiler designed for
speed, flexibility, and beautiful output. It decouples the introspection of
your code from the rendering process, allowing you to generate documentation
for various platforms (starting with MkDocs) from a single internal models.</p>
<h4 id="docforge--available-commands">Available Commands</h4>
<ul>
<li><strong>build</strong>: Build documentation (MkDocs site or MCP resources).</li>
<li><strong>serve</strong>: Serve documentation (MkDocs or MCP).</li>
<li><strong>tree</strong>: Visualize the introspected project structure.</li>
</ul>
<h4 id="docforge--installation">Installation</h4>
<p>Install using <code>pip</code> with the optional <code>mkdocs</code> dependencies for a complete setup:</p>
<pre><code class="language-bash">pip install doc-forge
</code></pre>
<h4 id="docforge--quick-start">Quick Start</h4>
<ol>
<li>
<p><strong>Build Documentation</strong>:
Introspect your package and generate documentation in one step:
```bash
# Build MkDocs site
doc-forge build --mkdocs --module my_package --site-name "My Docs"</p>
<h3 id="docforge--build-mcp-resources">Build MCP resources</h3>
<p>doc-forge build --mcp --module my_package
```</p>
</li>
<li>
<p><strong>Define Navigation</strong>:
Create a <code>docforge.nav.yml</code> to organize your documentation:
<code>yaml
home: my_package/index.md
groups:
Core API:
- my_package/core/*.md
Utilities:
- my_package/utils.md</code></p>
</li>
<li>
<p><strong>Preview</strong>:
```bash
# Serve MkDocs site
doc-forge serve --mkdocs</p>
<h3 id="docforge--serve-mcp-documentation">Serve MCP documentation</h3>
<p>doc-forge serve --mcp
```</p>
</li>
</ol>
<h4 id="docforge--project-structure">Project Structure</h4>
<ul>
<li><code>docforge.loaders</code>: Introspects source code using static analysis (<code>griffe</code>).</li>
<li><code>docforge.models</code>: The internal representation of your project, modules, and objects.</li>
<li><code>docforge.renderers</code>: Converters that turn the models into physical files.</li>
<li><code>docforge.nav</code>: Managers for logical-to-physical path mapping and navigation.</li>
</ul>
<div class="doc doc-children">
<div class="doc doc-object doc-class">
<h3 id="docforge.GriffeLoader" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">GriffeLoader</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">GriffeLoader</span><span class="p">()</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Loads Python modules and extracts documentation using the Griffe introspection engine.</p>
<p>Initialize the GriffeLoader.</p>
<div class="doc doc-children">
<div class="doc doc-object doc-function">
<h4 id="docforge.GriffeLoader.load_module" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">load_module</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">load_module</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Module</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Load a single module and convert its introspection data into the docforge models.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>path</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>The dotted path of the module to load.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="docforge.models.Module" href="models/#docforge.models.Module">Module</a></code>
</td>
<td>
<div class="doc-md-description">
<p>A Module instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="doc doc-object doc-function">
<h4 id="docforge.GriffeLoader.load_project" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">load_project</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">load_project</span><span class="p">(</span><span class="n">module_paths</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">project_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">skip_import_errors</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Project</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Load multiple modules and combine them into a single Project models.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>module_paths</code></td>
<td>
<code><span title="typing.List">List</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>A list of dotted paths to the modules to load.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>project_name</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional name for the project. Defaults to the first module name.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr class="doc-section-item">
<td><code>skip_import_errors</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>If True, modules that fail to import will be skipped.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="docforge.models.Project" href="models/#docforge.models.Project">Project</a></code>
</td>
<td>
<div class="doc-md-description">
<p>A Project instance containing the loaded modules.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="docforge.MCPRenderer" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">MCPRenderer</span>
</h3>
<div class="doc doc-contents ">
<p>Renderer that emits MCP-native JSON resources from docforge models.</p>
<div class="doc doc-children">
<div class="doc doc-object doc-function">
<h4 id="docforge.MCPRenderer.generate_sources" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">generate_sources</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Generate MCP-compatible JSON resources and navigation for the project.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>project</code></td>
<td>
<code><a class="autorefs autorefs-internal" title="docforge.models.Project" href="models/#docforge.models.Project">Project</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The project model to render.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>out_dir</code></td>
<td>
<code><span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Target directory for the generated JSON files.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h3 id="docforge.MkDocsRenderer" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">MkDocsRenderer</span>
</h3>
<div class="doc doc-contents ">
<p>Renderer that generates Markdown source files formatted for the MkDocs
'mkdocstrings' plugin.</p>
<div class="doc doc-children">
<div class="doc doc-object doc-function">
<h4 id="docforge.MkDocsRenderer.generate_sources" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">generate_sources</span>
</h4>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Produce a set of Markdown files in the output directory based on the
provided Project models.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>project</code></td>
<td>
<code><a class="autorefs autorefs-internal" title="docforge.models.Project" href="models/#docforge.models.Project">Project</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The project models to render.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>out_dir</code></td>
<td>
<code><span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Target directory for documentation files.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="docforge.discover_module_paths" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">discover_module_paths</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">discover_module_paths</span><span class="p">(</span><span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">project_root</span><span class="p">:</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
</code></pre></div>
<div class="doc doc-contents ">
<p>Discover all Python modules under a package via filesystem traversal.</p>
<p>Rules:
- Directory with <strong>init</strong>.py is treated as a package.
- Any .py file is treated as a module.
- All paths are converted to dotted module paths.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>module_name</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>The name of the package to discover.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>project_root</code></td>
<td>
<code><span title="pathlib.Path">Path</span> | None</code>
</td>
<td>
<div class="doc-md-description">
<p>The root directory of the project. Defaults to current working directory.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typing.List">List</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>A sorted list of dotted module paths.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink