Compare commits
6 Commits
0.0.4
...
bd294bea30
| Author | SHA1 | Date | |
|---|---|---|---|
| bd294bea30 | |||
| c82868d5a7 | |||
| 9a066eb0af | |||
| 711bef1dce | |||
| 8e97e571b7 | |||
| 03caf5ce4c |
327
ADS.llm.md
Normal file
327
ADS.llm.md
Normal file
@@ -0,0 +1,327 @@
|
||||
# doc-forge — Architecture & Design Specification
|
||||
|
||||
**doc-forge** is a renderer-agnostic Python documentation compiler. It converts Python source code and docstrings into a structured, semantic documentation model and then emits multiple downstream representations, including:
|
||||
|
||||
* Human-facing documentation sites (MkDocs, Sphinx)
|
||||
* Machine-facing documentation bundles (MCP JSON)
|
||||
* Live documentation APIs (MCP servers)
|
||||
|
||||
This document is the **authoritative design and codebase specification** for the library. It is written to be both **LLM-friendly** and **developer-facing**, and should be treated as the canonical reference for implementation decisions.
|
||||
|
||||
---
|
||||
|
||||
## 1. Design Goals
|
||||
|
||||
1. **Single Source of Truth**
|
||||
Python source code and docstrings are the only authoritative input.
|
||||
|
||||
2. **Renderer Agnosticism**
|
||||
MkDocs, Sphinx, MCP, or future renderers must not influence the core model.
|
||||
|
||||
3. **Deterministic Output**
|
||||
Given the same codebase, outputs must be reproducible.
|
||||
|
||||
4. **AI-Native Documentation**
|
||||
Documentation must be structured, queryable, and machine-consumable.
|
||||
|
||||
5. **Library-First, CLI-Second**
|
||||
All functionality must be accessible as a Python API. The CLI is a thin wrapper.
|
||||
|
||||
---
|
||||
|
||||
## 2. Core Mental Model
|
||||
|
||||
### Fundamental Abstraction
|
||||
|
||||
> **The atomic unit of documentation is a Python import path**
|
||||
|
||||
Examples:
|
||||
|
||||
* `mail_intake`
|
||||
* `mail_intake.config`
|
||||
* `mail_intake.adapters.base`
|
||||
|
||||
Files, Markdown, HTML, and JSON are *representations*, not documentation units.
|
||||
|
||||
---
|
||||
|
||||
## 3. High-Level Architecture
|
||||
|
||||
```
|
||||
Python Source Code
|
||||
↓
|
||||
Introspection Layer (Griffe)
|
||||
↓
|
||||
Documentation Model (doc-forge core)
|
||||
↓
|
||||
Renderer / Exporter Layer
|
||||
├── MkDocs
|
||||
├── Sphinx
|
||||
├── MCP (static JSON)
|
||||
└── MCP Server (live)
|
||||
```
|
||||
|
||||
Only the **Documentation Model** is shared across all outputs.
|
||||
|
||||
---
|
||||
|
||||
## 4. Package Layout (Proposed)
|
||||
|
||||
```
|
||||
docforge/
|
||||
├── __init__.py
|
||||
├── model/
|
||||
│ ├── project.py
|
||||
│ ├── module.py
|
||||
│ ├── object.py
|
||||
│ └── nav.py
|
||||
├── loader/
|
||||
│ └── griffe_loader.py
|
||||
├── renderers/
|
||||
│ ├── base.py
|
||||
│ ├── mkdocs.py
|
||||
│ └── sphinx.py
|
||||
├── exporters/
|
||||
│ └── mcp.py
|
||||
├── server/
|
||||
│ └── mcp_server.py
|
||||
├── cli/
|
||||
│ └── main.py
|
||||
└── utils/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Documentation Model (Core)
|
||||
|
||||
The documentation model is renderer-neutral and must not contain any MkDocs-, Sphinx-, or MCP-specific logic.
|
||||
|
||||
### 5.1 Project
|
||||
|
||||
```python
|
||||
class Project:
|
||||
name: str
|
||||
version: str | None
|
||||
modules: dict[str, Module]
|
||||
nav: Navigation
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 5.2 Module
|
||||
|
||||
```python
|
||||
class Module:
|
||||
path: str # import path
|
||||
docstring: str | None
|
||||
members: dict[str, DocObject]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 5.3 DocObject
|
||||
|
||||
Represents classes, functions, variables, etc.
|
||||
|
||||
```python
|
||||
class DocObject:
|
||||
name: str
|
||||
kind: str # class, function, attribute, module
|
||||
path: str
|
||||
signature: str | None
|
||||
docstring: str | None
|
||||
members: dict[str, DocObject]
|
||||
```
|
||||
|
||||
Private members (`_name`) are excluded by default.
|
||||
|
||||
---
|
||||
|
||||
### 5.4 Navigation
|
||||
|
||||
```python
|
||||
class Navigation:
|
||||
entries: list[NavEntry]
|
||||
|
||||
class NavEntry:
|
||||
title: str
|
||||
module: str
|
||||
```
|
||||
|
||||
Navigation is derived, not authored.
|
||||
|
||||
---
|
||||
|
||||
## 6. Introspection Layer
|
||||
|
||||
### 6.1 Griffe Loader
|
||||
|
||||
Griffe is the **only supported introspection backend**.
|
||||
|
||||
Responsibilities:
|
||||
|
||||
* Load modules by import path
|
||||
* Resolve docstrings, signatures, and members
|
||||
* Tolerate alias resolution failures
|
||||
|
||||
Output: fully populated `Project` and `Module` objects.
|
||||
|
||||
---
|
||||
|
||||
## 7. Renderer Interface
|
||||
|
||||
Renderers consume the documentation model and emit renderer-specific source trees.
|
||||
|
||||
```python
|
||||
class DocRenderer(Protocol):
|
||||
name: str
|
||||
|
||||
def generate_sources(self, project: Project, out_dir: Path) -> None:
|
||||
"""Generate renderer-specific source files."""
|
||||
|
||||
def build(self, config: RendererConfig) -> None:
|
||||
"""Build final artifacts (HTML, site, etc.)."""
|
||||
|
||||
def serve(self, config: RendererConfig) -> None:
|
||||
"""Serve documentation locally (optional)."""
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 8. MkDocs Renderer
|
||||
|
||||
### Source Generation
|
||||
|
||||
* Emits `.md` files
|
||||
* One file per module
|
||||
* Uses `mkdocstrings` directives exclusively
|
||||
|
||||
```md
|
||||
# Config
|
||||
|
||||
::: mail_intake.config
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
* Uses `mkdocs.commands.build`
|
||||
|
||||
### Serve
|
||||
|
||||
* Uses `mkdocs.commands.serve`
|
||||
|
||||
MkDocs-specific configuration lives outside the core model.
|
||||
|
||||
---
|
||||
|
||||
## 9. Sphinx Renderer
|
||||
|
||||
### Source Generation
|
||||
|
||||
* Emits `.rst` files
|
||||
* Uses `autodoc` directives
|
||||
|
||||
```rst
|
||||
mail_intake.config
|
||||
==================
|
||||
|
||||
.. automodule:: mail_intake.config
|
||||
:members:
|
||||
:undoc-members:
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
* Uses `sphinx.application.Sphinx` directly
|
||||
|
||||
### Serve
|
||||
|
||||
* Optional (static build is sufficient)
|
||||
|
||||
---
|
||||
|
||||
## 10. MCP Exporter (Static)
|
||||
|
||||
The MCP exporter bypasses renderers entirely.
|
||||
|
||||
### Output Structure
|
||||
|
||||
```
|
||||
mcp/
|
||||
├── index.json
|
||||
├── nav.json
|
||||
└── modules/
|
||||
└── package.module.json
|
||||
```
|
||||
|
||||
### Design Principles
|
||||
|
||||
* Alias-safe
|
||||
* Deterministic
|
||||
* Fully self-contained
|
||||
* No Markdown, HTML, or templates
|
||||
|
||||
---
|
||||
|
||||
## 11. MCP Server (Live)
|
||||
|
||||
The MCP server exposes documentation as queryable resources.
|
||||
|
||||
### Resources
|
||||
|
||||
* `docs://index`
|
||||
* `docs://nav`
|
||||
* `docs://module/{module}`
|
||||
|
||||
### Characteristics
|
||||
|
||||
* Read-only
|
||||
* Stateless
|
||||
* Backed by MCP JSON bundle
|
||||
|
||||
---
|
||||
|
||||
## 12. CLI Design
|
||||
|
||||
The CLI is a thin orchestration layer.
|
||||
|
||||
```bash
|
||||
doc-forge generate --renderer mkdocs
|
||||
doc-forge generate --renderer sphinx
|
||||
|
||||
doc-forge build --renderer mkdocs
|
||||
doc-forge serve --renderer mkdocs
|
||||
|
||||
doc-forge export mcp
|
||||
```
|
||||
|
||||
Renderer choice never affects the core model.
|
||||
|
||||
---
|
||||
|
||||
## 13. Explicit Non-Goals
|
||||
|
||||
* Markdown authoring
|
||||
* Theme design
|
||||
* Runtime code execution
|
||||
* Code formatting or linting
|
||||
|
||||
---
|
||||
|
||||
## 14. Invariants (Must Never Break)
|
||||
|
||||
1. Import paths are canonical identifiers
|
||||
2. Core model contains no renderer logic
|
||||
3. MCP does not depend on MkDocs or Sphinx
|
||||
4. Renderers do not introspect Python directly
|
||||
5. All outputs trace back to the same model
|
||||
|
||||
---
|
||||
|
||||
## 15. One-Line Definition
|
||||
|
||||
> **doc-forge is a documentation compiler that turns Python code into structured knowledge and emits it through multiple human and machine interfaces.**
|
||||
|
||||
---
|
||||
|
||||
*End of specification.*
|
||||
@@ -6,29 +6,6 @@ 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.
|
||||
|
||||
## Core Philosophy
|
||||
|
||||
`doc-forge` operates on two fundamental principles:
|
||||
|
||||
1. **The Atomic Unit is a Python Import Path**: Documentation is organized around the semantic structure of your code (e.g., `mypackage.utils`), not the filesystem.
|
||||
2. **The Documentation Compiler Paradigm**: We separate documentation into three distinct phases:
|
||||
- **Front-end (Introspection)**: Static analysis of source code and docstrings.
|
||||
- **Middle-end (Semantic Model)**: A renderer-neutral internal representation.
|
||||
- **Back-end (Renderers)**: Generation of human-facing (MkDocs) or machine-facing (MCP) outputs.
|
||||
|
||||
## Documentation Design
|
||||
|
||||
`doc-forge` is an "AI-Native" documentation compiler. To get the most out of it, design your docstrings with both humans and LLMs in mind:
|
||||
|
||||
### For Humans (Readability & Structure)
|
||||
- **`__init__.py` as Landing Pages**: Use the docstring of your package's `__init__.py` as the home page. Include overviews, installation instructions, and high-level examples here.
|
||||
- **Single Source of Truth**: Keep all technical details in docstrings. This ensures your MkDocs/Sphinx sites stay in sync with the code.
|
||||
- **Semantic Hierarchy**: Use standard Markdown headers to structure complex module documentation.
|
||||
|
||||
### For LLMs (AI-Native Knowledge)
|
||||
- **Model Context Protocol (MCP)**: `doc-forge` exports your docs as structured JSON. This allows AI agents to "understand" your API surface area without layout noise.
|
||||
- **Canonical Paths**: Use dotted import paths as primary identifiers. AI tools use these to link code usage to documentation.
|
||||
- **Type Annotations**: While not in docstrings, `doc-forge` (via Griffe) extracts signatures. Clean type hints dramatically improve an LLM's ability to generate correct code using your library.
|
||||
## Available Commands
|
||||
|
||||
- **build**: Build documentation (MkDocs site or MCP resources).
|
||||
|
||||
@@ -43,23 +43,6 @@ def build(
|
||||
) -> None:
|
||||
"""
|
||||
Build documentation (MkDocs site or MCP resources).
|
||||
|
||||
This command orchestrates the full build process:
|
||||
1. Introspects the code (Griffe)
|
||||
2. Renders sources (MkDocs Markdown or MCP JSON)
|
||||
3. (MkDocs only) Generates config and runs the final site build.
|
||||
|
||||
Args:
|
||||
mcp: Use the MCP documentation builder.
|
||||
mkdocs: Use the MkDocs documentation builder.
|
||||
module: The dotted path of the module to document.
|
||||
project_name: Optional override for the project name.
|
||||
site_name: (MkDocs) The site display name. Defaults to module name.
|
||||
docs_dir: (MkDocs) Target directory for Markdown sources.
|
||||
nav_file: (MkDocs) Path to the docforge.nav.yml specification.
|
||||
template: (MkDocs) Optional custom mkdocs.yml template.
|
||||
mkdocs_yml: (MkDocs) Target path for the generated mkdocs.yml.
|
||||
out_dir: (MCP) Target directory for MCP JSON resources.
|
||||
"""
|
||||
if not mcp and not mkdocs:
|
||||
raise click.UsageError("Must specify either --mcp or --mkdocs")
|
||||
@@ -92,62 +75,48 @@ def build(
|
||||
@cli.command()
|
||||
@click.option("--mcp", is_flag=True, help="Serve MCP documentation")
|
||||
@click.option("--mkdocs", is_flag=True, help="Serve MkDocs site")
|
||||
@click.option("--module", help="Python module to serve")
|
||||
@click.option("--mkdocs-yml", type=click.Path(path_type=Path), default=Path("mkdocs.yml"), help="MkDocs config path")
|
||||
@click.option("--out-dir", type=click.Path(path_type=Path), default=Path("mcp_docs"), help="MCP root directory")
|
||||
def serve(
|
||||
mcp: bool,
|
||||
mkdocs: bool,
|
||||
module: Optional[str],
|
||||
mkdocs_yml: Path,
|
||||
out_dir: Path,
|
||||
) -> None:
|
||||
"""
|
||||
Serve documentation (MkDocs or MCP).
|
||||
|
||||
Args:
|
||||
mcp: Serve MCP resources via an MCP server.
|
||||
mkdocs: Serve the MkDocs site using the built-in development server.
|
||||
module: The dotted path of the module to serve.
|
||||
mkdocs_yml: (MkDocs) Path to the mkdocs.yml configuration.
|
||||
out_dir: (MCP) Path to the mcp_docs/ directory.
|
||||
Serve documentation.
|
||||
"""
|
||||
if mcp and mkdocs:
|
||||
raise click.UsageError("Cannot specify both --mcp and --mkdocs")
|
||||
if not mcp and not mkdocs:
|
||||
raise click.UsageError("Must specify either --mcp or --mkdocs")
|
||||
if mcp and not module:
|
||||
raise click.UsageError("--module is required for MCP serve")
|
||||
|
||||
if mkdocs:
|
||||
mkdocs_utils.serve(mkdocs_yml)
|
||||
elif mcp:
|
||||
mcp_utils.serve(module, out_dir)
|
||||
mcp_utils.serve(out_dir)
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.option(
|
||||
"--module",
|
||||
"--modules",
|
||||
multiple=True,
|
||||
required=True,
|
||||
help="Python module import path to introspect",
|
||||
help="Python module import paths to introspect",
|
||||
)
|
||||
@click.option(
|
||||
"--project-name",
|
||||
help="Project name (defaults to specified module)",
|
||||
help="Project name (defaults to first module)",
|
||||
)
|
||||
def tree(
|
||||
module: str,
|
||||
modules: Sequence[str],
|
||||
project_name: Optional[str],
|
||||
) -> None:
|
||||
"""
|
||||
Visualize the project structure in the terminal.
|
||||
|
||||
Args:
|
||||
module: The module import path to recursively introspect.
|
||||
project_name: Optional override for the project name shown at the root.
|
||||
Visualize the project structure.
|
||||
"""
|
||||
loader = GriffeLoader()
|
||||
project = loader.load_project([module], project_name)
|
||||
project = loader.load_project(list(modules), project_name)
|
||||
|
||||
click.echo(project.name)
|
||||
|
||||
@@ -160,10 +129,6 @@ def tree(
|
||||
def _print_object(obj, indent: str) -> None:
|
||||
"""
|
||||
Recursive helper to print doc objects and their members to the console.
|
||||
|
||||
Args:
|
||||
obj: The DocObject instance to print.
|
||||
indent: Current line indentation (e.g., '│ ').
|
||||
"""
|
||||
click.echo(f"{indent}├── {obj.name}")
|
||||
for member in obj.get_all_members():
|
||||
|
||||
@@ -20,13 +20,12 @@ def build(
|
||||
def serve(
|
||||
mcp: bool,
|
||||
mkdocs: bool,
|
||||
module: Optional[str],
|
||||
mkdocs_yml: Path,
|
||||
out_dir: Path,
|
||||
) -> None: ...
|
||||
|
||||
def tree(
|
||||
module: str,
|
||||
modules: Sequence[str],
|
||||
project_name: Optional[str],
|
||||
) -> None: ...
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
"""
|
||||
Main entry point for the doc-forge CLI. This module delegates all command
|
||||
execution to docforge.cli.commands.
|
||||
Main entry point for the doc-forge CLI.
|
||||
"""
|
||||
from docforge.cli.commands import cli
|
||||
|
||||
|
||||
@@ -7,11 +7,6 @@ from docforge.servers import MCPServer
|
||||
def generate_resources(module: str, project_name: str | None, out_dir: Path) -> None:
|
||||
"""
|
||||
Generate MCP-compatible documentation resources.
|
||||
|
||||
Args:
|
||||
module: The dotted path of the primary module to document.
|
||||
project_name: Optional override for the project name.
|
||||
out_dir: Directory where the MCP JSON resources and nav will be written.
|
||||
"""
|
||||
loader = GriffeLoader()
|
||||
discovered_paths = discover_module_paths(module)
|
||||
@@ -20,13 +15,9 @@ def generate_resources(module: str, project_name: str | None, out_dir: Path) ->
|
||||
renderer = MCPRenderer()
|
||||
renderer.generate_sources(project, out_dir)
|
||||
|
||||
def serve(module: str, mcp_root: Path) -> None:
|
||||
def serve(mcp_root: Path) -> None:
|
||||
"""
|
||||
Serve MCP documentation from a pre-built bundle.
|
||||
|
||||
Args:
|
||||
module: The dotted path of the primary module to serve.
|
||||
mcp_root: Path to the directory containing index.json, nav.json, and modules/.
|
||||
Serve MCP documentation.
|
||||
"""
|
||||
if not mcp_root.exists():
|
||||
raise click.ClickException(f"mcp_docs directory not found: {mcp_root}")
|
||||
@@ -43,6 +34,6 @@ def serve(module: str, mcp_root: Path) -> None:
|
||||
|
||||
server = MCPServer(
|
||||
mcp_root=mcp_root,
|
||||
name=f"{module}-mcp",
|
||||
name="doc-forge-mcp",
|
||||
)
|
||||
server.run()
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
from pathlib import Path
|
||||
|
||||
def generate_resources(module: str, project_name: str | None, out_dir: Path) -> None: ...
|
||||
def serve(module: str, mcp_root: Path) -> None: ...
|
||||
def serve(mcp_root: Path) -> None: ...
|
||||
|
||||
@@ -9,11 +9,6 @@ from docforge.nav import load_nav_spec, resolve_nav, MkDocsNavEmitter
|
||||
def generate_sources(module: str, project_name: str | None, docs_dir: Path) -> None:
|
||||
"""
|
||||
Generate Markdown source files for the specified module.
|
||||
|
||||
Args:
|
||||
module: The dotted path of the primary module to document.
|
||||
project_name: Optional override for the project name.
|
||||
docs_dir: Directory where the generated Markdown files will be written.
|
||||
"""
|
||||
loader = GriffeLoader()
|
||||
discovered_paths = discover_module_paths(module)
|
||||
@@ -25,13 +20,6 @@ def generate_sources(module: str, project_name: str | None, docs_dir: Path) -> N
|
||||
def generate_config(docs_dir: Path, nav_file: Path, template: Path | None, out: Path, site_name: str) -> None:
|
||||
"""
|
||||
Generate an mkdocs.yml configuration file.
|
||||
|
||||
Args:
|
||||
docs_dir: Path to the directory containing documentation Markdown files.
|
||||
nav_file: Path to the docforge.nav.yml specification.
|
||||
template: Optional path to an mkdocs.yml template (overrides built-in).
|
||||
out: Path where the final mkdocs.yml will be written.
|
||||
site_name: The display name for the documentation site.
|
||||
"""
|
||||
if not nav_file.exists():
|
||||
raise click.FileError(str(nav_file), hint="Nav spec not found")
|
||||
@@ -61,9 +49,6 @@ def generate_config(docs_dir: Path, nav_file: Path, template: Path | None, out:
|
||||
def build(mkdocs_yml: Path) -> None:
|
||||
"""
|
||||
Build the documentation site using MkDocs.
|
||||
|
||||
Args:
|
||||
mkdocs_yml: Path to the mkdocs.yml configuration file.
|
||||
"""
|
||||
if not mkdocs_yml.exists():
|
||||
raise click.ClickException(f"mkdocs.yml not found: {mkdocs_yml}")
|
||||
@@ -76,9 +61,6 @@ def build(mkdocs_yml: Path) -> None:
|
||||
def serve(mkdocs_yml: Path) -> None:
|
||||
"""
|
||||
Serve the documentation site with live-reload using MkDocs.
|
||||
|
||||
Args:
|
||||
mkdocs_yml: Path to the mkdocs.yml configuration file.
|
||||
"""
|
||||
if not mkdocs_yml.exists():
|
||||
raise click.ClickException(f"mkdocs.yml not found: {mkdocs_yml}")
|
||||
|
||||
@@ -15,10 +15,6 @@ class MCPRenderer:
|
||||
def generate_sources(self, project: Project, out_dir: Path) -> None:
|
||||
"""
|
||||
Generate MCP-compatible JSON resources and navigation for the project.
|
||||
|
||||
Args:
|
||||
project: The project model to render.
|
||||
out_dir: Target directory for the generated JSON files.
|
||||
"""
|
||||
modules_dir = out_dir / "modules"
|
||||
modules_dir.mkdir(parents=True, exist_ok=True)
|
||||
@@ -54,11 +50,7 @@ class MCPRenderer:
|
||||
|
||||
def _write_module(self, module: Module, modules_dir: Path) -> None:
|
||||
"""
|
||||
Serialize a module into an MCP JSON resource on disk.
|
||||
|
||||
Args:
|
||||
module: The module instance to serialize.
|
||||
modules_dir: The directory where the module JSON file should be written.
|
||||
Serialize a module into an MCP JSON resource.
|
||||
"""
|
||||
payload = {
|
||||
"module": module.path,
|
||||
@@ -72,12 +64,6 @@ class MCPRenderer:
|
||||
def _render_module(self, module: Module) -> Dict:
|
||||
"""
|
||||
Render a Module into MCP-friendly structured data.
|
||||
|
||||
Args:
|
||||
module: The module instance to render.
|
||||
|
||||
Returns:
|
||||
A dictionary following the MCP documentation resource schema.
|
||||
"""
|
||||
data: Dict = {
|
||||
"path": module.path,
|
||||
@@ -93,12 +79,6 @@ class MCPRenderer:
|
||||
def _render_object(self, obj: DocObject) -> Dict:
|
||||
"""
|
||||
Recursively render a DocObject into structured MCP data.
|
||||
|
||||
Args:
|
||||
obj: The documented object (class, func, etc.) to render.
|
||||
|
||||
Returns:
|
||||
A dictionary representing the object and its members.
|
||||
"""
|
||||
data: Dict = {
|
||||
"name": obj.name,
|
||||
|
||||
@@ -178,28 +178,28 @@
|
||||
"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 Markdown source files for the specified module.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n docs_dir: Directory where the generated Markdown files will be written."
|
||||
"docstring": "Generate Markdown source files for the specified module."
|
||||
},
|
||||
"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\nArgs:\n docs_dir: Path to the directory containing documentation Markdown files.\n nav_file: Path to the docforge.nav.yml specification.\n template: Optional path to an mkdocs.yml template (overrides built-in).\n out: Path where the final mkdocs.yml will be written.\n site_name: The display name for the documentation site."
|
||||
"docstring": "Generate an mkdocs.yml configuration file."
|
||||
},
|
||||
"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 documentation site using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"docstring": "Build the documentation site using MkDocs."
|
||||
},
|
||||
"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": "Serve the documentation site with live-reload using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -273,7 +273,7 @@
|
||||
"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-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -312,58 +312,44 @@
|
||||
"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-compatible documentation resources.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n out_dir: Directory where the MCP JSON resources and nav will be written."
|
||||
"docstring": "Generate MCP-compatible documentation resources."
|
||||
},
|
||||
"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": "Serve MCP documentation from a pre-built bundle.\n\nArgs:\n mcp_root: Path to the directory containing index.json, nav.json, and modules/."
|
||||
"docstring": "Serve MCP documentation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"cli": {
|
||||
"name": "cli",
|
||||
"kind": "attribute",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.cli",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
"signature": "<bound method Function.signature of Function('cli', 9, 15)>",
|
||||
"docstring": "doc-forge CLI: A tool for introspecting Python projects and generating\ndocumentation."
|
||||
},
|
||||
"build": {
|
||||
"name": "build",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.build",
|
||||
"signature": "<bound method Function.signature of Function('build', 18, 89)>",
|
||||
"docstring": "Build documentation (MkDocs site or MCP resources).\n\nThis command orchestrates the full build process:\n1. Introspects the code (Griffe)\n2. Renders sources (MkDocs Markdown or MCP JSON)\n3. (MkDocs only) Generates config and runs the final site build.\n\nArgs:\n mcp: Use the MCP documentation builder.\n mkdocs: Use the MkDocs documentation builder.\n module: The dotted path of the module to document.\n project_name: Optional override for the project name.\n site_name: (MkDocs) The site display name. Defaults to module name.\n docs_dir: (MkDocs) Target directory for Markdown sources.\n nav_file: (MkDocs) Path to the docforge.nav.yml specification.\n template: (MkDocs) Optional custom mkdocs.yml template.\n mkdocs_yml: (MkDocs) Target path for the generated mkdocs.yml.\n out_dir: (MCP) Target directory for MCP JSON resources."
|
||||
"signature": "<bound method Function.signature of Function('build', 18, 72)>",
|
||||
"docstring": "Build documentation (MkDocs site or MCP resources)."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 92, 120)>",
|
||||
"docstring": "Serve documentation (MkDocs or MCP).\n\nArgs:\n mcp: Serve MCP resources via an MCP server.\n mkdocs: Serve the MkDocs site using the built-in development server.\n mkdocs_yml: (MkDocs) Path to the mkdocs.yml configuration.\n out_dir: (MCP) Path to the mcp_docs/ directory."
|
||||
"signature": "<bound method Function.signature of Function('serve', 75, 97)>",
|
||||
"docstring": "Serve documentation."
|
||||
},
|
||||
"tree": {
|
||||
"name": "tree",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.tree",
|
||||
"signature": "<bound method Function.signature of Function('tree', 123, 153)>",
|
||||
"docstring": "Visualize the project structure in the terminal.\n\nArgs:\n modules: List of module import paths to recursively introspect.\n project_name: Optional override for the project name shown at the root."
|
||||
},
|
||||
"Group": {
|
||||
"name": "Group",
|
||||
"kind": "alias",
|
||||
"path": "docforge.cli.commands.Group",
|
||||
"signature": "<bound method Alias.signature of Alias('Group', 'click.core.Group')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "docforge.cli.commands.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
"signature": "<bound method Function.signature of Function('tree', 100, 126)>",
|
||||
"docstring": "Visualize the project structure."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,27 +2,27 @@
|
||||
"module": "docforge.cli",
|
||||
"content": {
|
||||
"path": "docforge.cli",
|
||||
"docstring": "# CLI Layer\n\nThe `docforge.cli` package provides the command-line interface for interacting\nwith doc-forge.\n\n## Available Commands\n\n- **build**: Build documentation (MkDocs site or MCP resources).\n- **serve**: Serve documentation (MkDocs or MCP).\n- **tree**: Visualize the introspected project structure.",
|
||||
"docstring": "# CLI Layer\n\nThe `docforge.cli` package provides the command-line interface for interacting\nwith doc-forge.\n\n## Available Commands\n\n- **tree**: Visualize the introspected project structure.\n- **generate**: Create Markdown source files from Python code.\n- **mkdocs**: Generate the primary `mkdocs.yml` configuration.\n- **build**: Build the final documentation site.\n- **serve**: Launch a local development server with live-reloading.",
|
||||
"objects": {
|
||||
"main": {
|
||||
"name": "main",
|
||||
"kind": "module",
|
||||
"path": "docforge.cli.main",
|
||||
"signature": null,
|
||||
"docstring": "Main entry point for the doc-forge CLI. This module delegates all command\nexecution to docforge.cli.commands.",
|
||||
"docstring": "Main entry point for the doc-forge CLI.",
|
||||
"members": {
|
||||
"cli": {
|
||||
"name": "cli",
|
||||
"kind": "attribute",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.main.cli",
|
||||
"signature": "<bound method Alias.signature of Alias('cli', 'docforge.cli.commands.cli')>",
|
||||
"docstring": null
|
||||
"docstring": "doc-forge CLI: A tool for introspecting Python projects and generating\ndocumentation."
|
||||
},
|
||||
"main": {
|
||||
"name": "main",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.main.main",
|
||||
"signature": "<bound method Function.signature of Function('main', 7, 11)>",
|
||||
"signature": "<bound method Function.signature of Function('main', 6, 10)>",
|
||||
"docstring": "CLI Entry point. Boots the click application."
|
||||
}
|
||||
}
|
||||
@@ -208,28 +208,28 @@
|
||||
"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 Markdown source files for the specified module.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n docs_dir: Directory where the generated Markdown files will be written."
|
||||
"docstring": "Generate Markdown source files for the specified module."
|
||||
},
|
||||
"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\nArgs:\n docs_dir: Path to the directory containing documentation Markdown files.\n nav_file: Path to the docforge.nav.yml specification.\n template: Optional path to an mkdocs.yml template (overrides built-in).\n out: Path where the final mkdocs.yml will be written.\n site_name: The display name for the documentation site."
|
||||
"docstring": "Generate an mkdocs.yml configuration file."
|
||||
},
|
||||
"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 documentation site using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"docstring": "Build the documentation site using MkDocs."
|
||||
},
|
||||
"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": "Serve the documentation site with live-reload using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -303,7 +303,7 @@
|
||||
"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-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -342,58 +342,44 @@
|
||||
"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-compatible documentation resources.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n out_dir: Directory where the MCP JSON resources and nav will be written."
|
||||
"docstring": "Generate MCP-compatible documentation resources."
|
||||
},
|
||||
"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": "Serve MCP documentation from a pre-built bundle.\n\nArgs:\n mcp_root: Path to the directory containing index.json, nav.json, and modules/."
|
||||
"docstring": "Serve MCP documentation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"cli": {
|
||||
"name": "cli",
|
||||
"kind": "attribute",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.cli",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
"signature": "<bound method Function.signature of Function('cli', 9, 15)>",
|
||||
"docstring": "doc-forge CLI: A tool for introspecting Python projects and generating\ndocumentation."
|
||||
},
|
||||
"build": {
|
||||
"name": "build",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.build",
|
||||
"signature": "<bound method Function.signature of Function('build', 18, 89)>",
|
||||
"docstring": "Build documentation (MkDocs site or MCP resources).\n\nThis command orchestrates the full build process:\n1. Introspects the code (Griffe)\n2. Renders sources (MkDocs Markdown or MCP JSON)\n3. (MkDocs only) Generates config and runs the final site build.\n\nArgs:\n mcp: Use the MCP documentation builder.\n mkdocs: Use the MkDocs documentation builder.\n module: The dotted path of the module to document.\n project_name: Optional override for the project name.\n site_name: (MkDocs) The site display name. Defaults to module name.\n docs_dir: (MkDocs) Target directory for Markdown sources.\n nav_file: (MkDocs) Path to the docforge.nav.yml specification.\n template: (MkDocs) Optional custom mkdocs.yml template.\n mkdocs_yml: (MkDocs) Target path for the generated mkdocs.yml.\n out_dir: (MCP) Target directory for MCP JSON resources."
|
||||
"signature": "<bound method Function.signature of Function('build', 18, 72)>",
|
||||
"docstring": "Build documentation (MkDocs site or MCP resources)."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 92, 120)>",
|
||||
"docstring": "Serve documentation (MkDocs or MCP).\n\nArgs:\n mcp: Serve MCP resources via an MCP server.\n mkdocs: Serve the MkDocs site using the built-in development server.\n mkdocs_yml: (MkDocs) Path to the mkdocs.yml configuration.\n out_dir: (MCP) Path to the mcp_docs/ directory."
|
||||
"signature": "<bound method Function.signature of Function('serve', 75, 97)>",
|
||||
"docstring": "Serve documentation."
|
||||
},
|
||||
"tree": {
|
||||
"name": "tree",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.tree",
|
||||
"signature": "<bound method Function.signature of Function('tree', 123, 153)>",
|
||||
"docstring": "Visualize the project structure in the terminal.\n\nArgs:\n modules: List of module import paths to recursively introspect.\n project_name: Optional override for the project name shown at the root."
|
||||
},
|
||||
"Group": {
|
||||
"name": "Group",
|
||||
"kind": "alias",
|
||||
"path": "docforge.cli.commands.Group",
|
||||
"signature": "<bound method Alias.signature of Alias('Group', 'click.core.Group')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "docforge.cli.commands.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
"signature": "<bound method Function.signature of Function('tree', 100, 126)>",
|
||||
"docstring": "Visualize the project structure."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -467,7 +453,7 @@
|
||||
"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-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -505,15 +491,15 @@
|
||||
"name": "generate_resources",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mcp_utils.generate_resources",
|
||||
"signature": "<bound method Function.signature of Function('generate_resources', 7, 21)>",
|
||||
"docstring": "Generate MCP-compatible documentation resources.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n out_dir: Directory where the MCP JSON resources and nav will be written."
|
||||
"signature": "<bound method Function.signature of Function('generate_resources', 7, 16)>",
|
||||
"docstring": "Generate MCP-compatible documentation resources."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mcp_utils.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 23, 47)>",
|
||||
"docstring": "Serve MCP documentation from a pre-built bundle.\n\nArgs:\n mcp_root: Path to the directory containing index.json, nav.json, and modules/."
|
||||
"signature": "<bound method Function.signature of Function('serve', 18, 39)>",
|
||||
"docstring": "Serve MCP documentation."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -639,29 +625,29 @@
|
||||
"name": "generate_sources",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.generate_sources",
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 9, 23)>",
|
||||
"docstring": "Generate Markdown source files for the specified module.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n docs_dir: Directory where the generated Markdown files will be written."
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 9, 18)>",
|
||||
"docstring": "Generate Markdown source files for the specified module."
|
||||
},
|
||||
"generate_config": {
|
||||
"name": "generate_config",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.generate_config",
|
||||
"signature": "<bound method Function.signature of Function('generate_config', 25, 59)>",
|
||||
"docstring": "Generate an mkdocs.yml configuration file.\n\nArgs:\n docs_dir: Path to the directory containing documentation Markdown files.\n nav_file: Path to the docforge.nav.yml specification.\n template: Optional path to an mkdocs.yml template (overrides built-in).\n out: Path where the final mkdocs.yml will be written.\n site_name: The display name for the documentation site."
|
||||
"signature": "<bound method Function.signature of Function('generate_config', 20, 47)>",
|
||||
"docstring": "Generate an mkdocs.yml configuration file."
|
||||
},
|
||||
"build": {
|
||||
"name": "build",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.build",
|
||||
"signature": "<bound method Function.signature of Function('build', 61, 74)>",
|
||||
"docstring": "Build the documentation site using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"signature": "<bound method Function.signature of Function('build', 49, 59)>",
|
||||
"docstring": "Build the documentation site using MkDocs."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 76, 87)>",
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"signature": "<bound method Function.signature of Function('serve', 61, 69)>",
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,20 +2,20 @@
|
||||
"module": "docforge.cli.main",
|
||||
"content": {
|
||||
"path": "docforge.cli.main",
|
||||
"docstring": "Main entry point for the doc-forge CLI. This module delegates all command\nexecution to docforge.cli.commands.",
|
||||
"docstring": "Main entry point for the doc-forge CLI.",
|
||||
"objects": {
|
||||
"cli": {
|
||||
"name": "cli",
|
||||
"kind": "attribute",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.main.cli",
|
||||
"signature": "<bound method Alias.signature of Alias('cli', 'docforge.cli.commands.cli')>",
|
||||
"docstring": null
|
||||
"docstring": "doc-forge CLI: A tool for introspecting Python projects and generating\ndocumentation."
|
||||
},
|
||||
"main": {
|
||||
"name": "main",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.main.main",
|
||||
"signature": "<bound method Function.signature of Function('main', 7, 11)>",
|
||||
"signature": "<bound method Function.signature of Function('main', 6, 10)>",
|
||||
"docstring": "CLI Entry point. Boots the click application."
|
||||
}
|
||||
}
|
||||
|
||||
@@ -67,7 +67,7 @@
|
||||
"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-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -105,15 +105,15 @@
|
||||
"name": "generate_resources",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mcp_utils.generate_resources",
|
||||
"signature": "<bound method Function.signature of Function('generate_resources', 7, 21)>",
|
||||
"docstring": "Generate MCP-compatible documentation resources.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n out_dir: Directory where the MCP JSON resources and nav will be written."
|
||||
"signature": "<bound method Function.signature of Function('generate_resources', 7, 16)>",
|
||||
"docstring": "Generate MCP-compatible documentation resources."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mcp_utils.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 23, 47)>",
|
||||
"docstring": "Serve MCP documentation from a pre-built bundle.\n\nArgs:\n mcp_root: Path to the directory containing index.json, nav.json, and modules/."
|
||||
"signature": "<bound method Function.signature of Function('serve', 18, 39)>",
|
||||
"docstring": "Serve MCP documentation."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -119,29 +119,29 @@
|
||||
"name": "generate_sources",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.generate_sources",
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 9, 23)>",
|
||||
"docstring": "Generate Markdown source files for the specified module.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n docs_dir: Directory where the generated Markdown files will be written."
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 9, 18)>",
|
||||
"docstring": "Generate Markdown source files for the specified module."
|
||||
},
|
||||
"generate_config": {
|
||||
"name": "generate_config",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.generate_config",
|
||||
"signature": "<bound method Function.signature of Function('generate_config', 25, 59)>",
|
||||
"docstring": "Generate an mkdocs.yml configuration file.\n\nArgs:\n docs_dir: Path to the directory containing documentation Markdown files.\n nav_file: Path to the docforge.nav.yml specification.\n template: Optional path to an mkdocs.yml template (overrides built-in).\n out: Path where the final mkdocs.yml will be written.\n site_name: The display name for the documentation site."
|
||||
"signature": "<bound method Function.signature of Function('generate_config', 20, 47)>",
|
||||
"docstring": "Generate an mkdocs.yml configuration file."
|
||||
},
|
||||
"build": {
|
||||
"name": "build",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.build",
|
||||
"signature": "<bound method Function.signature of Function('build', 61, 74)>",
|
||||
"docstring": "Build the documentation site using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"signature": "<bound method Function.signature of Function('build', 49, 59)>",
|
||||
"docstring": "Build the documentation site using MkDocs."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 76, 87)>",
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"signature": "<bound method Function.signature of Function('serve', 61, 69)>",
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"module": "docforge",
|
||||
"content": {
|
||||
"path": "docforge",
|
||||
"docstring": "# doc-forge\n\n`doc-forge` is a renderer-agnostic Python documentation compiler designed for\nspeed, flexibility, and beautiful output. It decouples the introspection of\nyour code from the rendering process, allowing you to generate documentation\nfor various platforms (starting with MkDocs) from a single internal models.\n\n## Available Commands\n\n- **build**: Build documentation (MkDocs site or MCP resources).\n- **serve**: Serve documentation (MkDocs or MCP).\n- **tree**: Visualize the introspected project structure.\n\n## Installation\n\nInstall using `pip` with the optional `mkdocs` dependencies for a complete setup:\n\n```bash\npip install doc-forge\n```\n\n## Quick Start\n\n1. **Build Documentation**:\n Introspect your package and generate documentation in one step:\n ```bash\n # Build MkDocs site\n doc-forge build --mkdocs --module my_package --site-name \"My Docs\"\n\n # Build MCP resources\n doc-forge build --mcp --module my_package\n ```\n\n2. **Define Navigation**:\n Create a `docforge.nav.yml` to organize your documentation:\n ```yaml\n home: my_package/index.md\n groups:\n Core API:\n - my_package/core/*.md\n Utilities:\n - my_package/utils.md\n ```\n\n3. **Preview**:\n ```bash\n # Serve MkDocs site\n doc-forge serve --mkdocs\n\n # Serve MCP documentation\n doc-forge serve --mcp\n ```\n\n## Project Structure\n\n- `docforge.loaders`: Introspects source code using static analysis (`griffe`).\n- `docforge.models`: The internal representation of your project, modules, and objects.\n- `docforge.renderers`: Converters that turn the models into physical files.\n- `docforge.nav`: Managers for logical-to-physical path mapping and navigation.",
|
||||
"docstring": "# doc-forge\n\n`doc-forge` is a renderer-agnostic Python documentation compiler designed for\nspeed, flexibility, and beautiful output. It decouples the introspection of\nyour code from the rendering process, allowing you to generate documentation\nfor various platforms (starting with MkDocs) from a single internal models.\n\n## Installation\n\nInstall using `pip` with the optional `mkdocs` dependencies for a complete setup:\n\n```bash\npip install doc-forge\n```\n\n## Quick Start\n\n1. **Generate Markdown Sources**:\n Introspect your package and create ready-to-use Markdown files:\n ```bash\n doc-forge generate --module my_package --docs-dir docs\n ```\n\n2. **Define Navigation**:\n Create a `docforge.nav.yml` to organize your documentation:\n ```yaml\n home: my_package/index.md\n groups:\n Core API:\n - my_package/core/*.md\n Utilities:\n - my_package/utils.md\n ```\n\n3. **Generate MkDocs Configuration**:\n ```bash\n doc-forge mkdocs --site-name \"My Awesome Docs\"\n ```\n\n4. **Preview**:\n ```bash\n doc-forge serve\n ```\n\n## Project Structure\n\n- `docforge.loaders`: Introspects source code using static analysis (`griffe`).\n- `docforge.models`: The internal representation of your project, modules, and objects.\n- `docforge.renderers`: Converters that turn the models into physical files.\n- `docforge.nav`: Managers for logical-to-physical path mapping and navigation.",
|
||||
"objects": {
|
||||
"GriffeLoader": {
|
||||
"name": "GriffeLoader",
|
||||
@@ -76,7 +76,7 @@
|
||||
"kind": "function",
|
||||
"path": "docforge.MCPRenderer.generate_sources",
|
||||
"signature": "<bound method Alias.signature of Alias('generate_sources', 'docforge.renderers.mcp_renderer.MCPRenderer.generate_sources')>",
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -85,14 +85,14 @@
|
||||
"kind": "module",
|
||||
"path": "docforge.main",
|
||||
"signature": "<bound method Alias.signature of Alias('main', 'docforge.cli.main')>",
|
||||
"docstring": "Main entry point for the doc-forge CLI. This module delegates all command\nexecution to docforge.cli.commands.",
|
||||
"docstring": "Main entry point for the doc-forge CLI.",
|
||||
"members": {
|
||||
"cli": {
|
||||
"name": "cli",
|
||||
"kind": "attribute",
|
||||
"kind": "function",
|
||||
"path": "docforge.main.cli",
|
||||
"signature": "<bound method Alias.signature of Alias('cli', 'docforge.cli.main.cli')>",
|
||||
"docstring": null
|
||||
"docstring": "doc-forge CLI: A tool for introspecting Python projects and generating\ndocumentation."
|
||||
},
|
||||
"main": {
|
||||
"name": "main",
|
||||
@@ -108,27 +108,27 @@
|
||||
"kind": "module",
|
||||
"path": "docforge.cli",
|
||||
"signature": null,
|
||||
"docstring": "# CLI Layer\n\nThe `docforge.cli` package provides the command-line interface for interacting\nwith doc-forge.\n\n## Available Commands\n\n- **build**: Build documentation (MkDocs site or MCP resources).\n- **serve**: Serve documentation (MkDocs or MCP).\n- **tree**: Visualize the introspected project structure.",
|
||||
"docstring": "# CLI Layer\n\nThe `docforge.cli` package provides the command-line interface for interacting\nwith doc-forge.\n\n## Available Commands\n\n- **tree**: Visualize the introspected project structure.\n- **generate**: Create Markdown source files from Python code.\n- **mkdocs**: Generate the primary `mkdocs.yml` configuration.\n- **build**: Build the final documentation site.\n- **serve**: Launch a local development server with live-reloading.",
|
||||
"members": {
|
||||
"main": {
|
||||
"name": "main",
|
||||
"kind": "module",
|
||||
"path": "docforge.cli.main",
|
||||
"signature": null,
|
||||
"docstring": "Main entry point for the doc-forge CLI. This module delegates all command\nexecution to docforge.cli.commands.",
|
||||
"docstring": "Main entry point for the doc-forge CLI.",
|
||||
"members": {
|
||||
"cli": {
|
||||
"name": "cli",
|
||||
"kind": "attribute",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.main.cli",
|
||||
"signature": "<bound method Alias.signature of Alias('cli', 'docforge.cli.commands.cli')>",
|
||||
"docstring": null
|
||||
"docstring": "doc-forge CLI: A tool for introspecting Python projects and generating\ndocumentation."
|
||||
},
|
||||
"main": {
|
||||
"name": "main",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.main.main",
|
||||
"signature": "<bound method Function.signature of Function('main', 7, 11)>",
|
||||
"signature": "<bound method Function.signature of Function('main', 6, 10)>",
|
||||
"docstring": "CLI Entry point. Boots the click application."
|
||||
}
|
||||
}
|
||||
@@ -314,28 +314,28 @@
|
||||
"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 Markdown source files for the specified module.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n docs_dir: Directory where the generated Markdown files will be written."
|
||||
"docstring": "Generate Markdown source files for the specified module."
|
||||
},
|
||||
"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\nArgs:\n docs_dir: Path to the directory containing documentation Markdown files.\n nav_file: Path to the docforge.nav.yml specification.\n template: Optional path to an mkdocs.yml template (overrides built-in).\n out: Path where the final mkdocs.yml will be written.\n site_name: The display name for the documentation site."
|
||||
"docstring": "Generate an mkdocs.yml configuration file."
|
||||
},
|
||||
"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 documentation site using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"docstring": "Build the documentation site using MkDocs."
|
||||
},
|
||||
"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": "Serve the documentation site with live-reload using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -409,7 +409,7 @@
|
||||
"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-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -448,58 +448,44 @@
|
||||
"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-compatible documentation resources.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n out_dir: Directory where the MCP JSON resources and nav will be written."
|
||||
"docstring": "Generate MCP-compatible documentation resources."
|
||||
},
|
||||
"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": "Serve MCP documentation from a pre-built bundle.\n\nArgs:\n mcp_root: Path to the directory containing index.json, nav.json, and modules/."
|
||||
"docstring": "Serve MCP documentation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"cli": {
|
||||
"name": "cli",
|
||||
"kind": "attribute",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.cli",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
"signature": "<bound method Function.signature of Function('cli', 9, 15)>",
|
||||
"docstring": "doc-forge CLI: A tool for introspecting Python projects and generating\ndocumentation."
|
||||
},
|
||||
"build": {
|
||||
"name": "build",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.build",
|
||||
"signature": "<bound method Function.signature of Function('build', 18, 89)>",
|
||||
"docstring": "Build documentation (MkDocs site or MCP resources).\n\nThis command orchestrates the full build process:\n1. Introspects the code (Griffe)\n2. Renders sources (MkDocs Markdown or MCP JSON)\n3. (MkDocs only) Generates config and runs the final site build.\n\nArgs:\n mcp: Use the MCP documentation builder.\n mkdocs: Use the MkDocs documentation builder.\n module: The dotted path of the module to document.\n project_name: Optional override for the project name.\n site_name: (MkDocs) The site display name. Defaults to module name.\n docs_dir: (MkDocs) Target directory for Markdown sources.\n nav_file: (MkDocs) Path to the docforge.nav.yml specification.\n template: (MkDocs) Optional custom mkdocs.yml template.\n mkdocs_yml: (MkDocs) Target path for the generated mkdocs.yml.\n out_dir: (MCP) Target directory for MCP JSON resources."
|
||||
"signature": "<bound method Function.signature of Function('build', 18, 72)>",
|
||||
"docstring": "Build documentation (MkDocs site or MCP resources)."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 92, 120)>",
|
||||
"docstring": "Serve documentation (MkDocs or MCP).\n\nArgs:\n mcp: Serve MCP resources via an MCP server.\n mkdocs: Serve the MkDocs site using the built-in development server.\n mkdocs_yml: (MkDocs) Path to the mkdocs.yml configuration.\n out_dir: (MCP) Path to the mcp_docs/ directory."
|
||||
"signature": "<bound method Function.signature of Function('serve', 75, 97)>",
|
||||
"docstring": "Serve documentation."
|
||||
},
|
||||
"tree": {
|
||||
"name": "tree",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.commands.tree",
|
||||
"signature": "<bound method Function.signature of Function('tree', 123, 153)>",
|
||||
"docstring": "Visualize the project structure in the terminal.\n\nArgs:\n modules: List of module import paths to recursively introspect.\n project_name: Optional override for the project name shown at the root."
|
||||
},
|
||||
"Group": {
|
||||
"name": "Group",
|
||||
"kind": "alias",
|
||||
"path": "docforge.cli.commands.Group",
|
||||
"signature": "<bound method Alias.signature of Alias('Group', 'click.core.Group')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "docforge.cli.commands.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
"signature": "<bound method Function.signature of Function('tree', 100, 126)>",
|
||||
"docstring": "Visualize the project structure."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -573,7 +559,7 @@
|
||||
"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-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -611,15 +597,15 @@
|
||||
"name": "generate_resources",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mcp_utils.generate_resources",
|
||||
"signature": "<bound method Function.signature of Function('generate_resources', 7, 21)>",
|
||||
"docstring": "Generate MCP-compatible documentation resources.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n out_dir: Directory where the MCP JSON resources and nav will be written."
|
||||
"signature": "<bound method Function.signature of Function('generate_resources', 7, 16)>",
|
||||
"docstring": "Generate MCP-compatible documentation resources."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mcp_utils.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 23, 47)>",
|
||||
"docstring": "Serve MCP documentation from a pre-built bundle.\n\nArgs:\n mcp_root: Path to the directory containing index.json, nav.json, and modules/."
|
||||
"signature": "<bound method Function.signature of Function('serve', 18, 39)>",
|
||||
"docstring": "Serve MCP documentation."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -745,29 +731,29 @@
|
||||
"name": "generate_sources",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.generate_sources",
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 9, 23)>",
|
||||
"docstring": "Generate Markdown source files for the specified module.\n\nArgs:\n module: The dotted path of the primary module to document.\n project_name: Optional override for the project name.\n docs_dir: Directory where the generated Markdown files will be written."
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 9, 18)>",
|
||||
"docstring": "Generate Markdown source files for the specified module."
|
||||
},
|
||||
"generate_config": {
|
||||
"name": "generate_config",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.generate_config",
|
||||
"signature": "<bound method Function.signature of Function('generate_config', 25, 59)>",
|
||||
"docstring": "Generate an mkdocs.yml configuration file.\n\nArgs:\n docs_dir: Path to the directory containing documentation Markdown files.\n nav_file: Path to the docforge.nav.yml specification.\n template: Optional path to an mkdocs.yml template (overrides built-in).\n out: Path where the final mkdocs.yml will be written.\n site_name: The display name for the documentation site."
|
||||
"signature": "<bound method Function.signature of Function('generate_config', 20, 47)>",
|
||||
"docstring": "Generate an mkdocs.yml configuration file."
|
||||
},
|
||||
"build": {
|
||||
"name": "build",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.build",
|
||||
"signature": "<bound method Function.signature of Function('build', 61, 74)>",
|
||||
"docstring": "Build the documentation site using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"signature": "<bound method Function.signature of Function('build', 49, 59)>",
|
||||
"docstring": "Build the documentation site using MkDocs."
|
||||
},
|
||||
"serve": {
|
||||
"name": "serve",
|
||||
"kind": "function",
|
||||
"path": "docforge.cli.mkdocs_utils.serve",
|
||||
"signature": "<bound method Function.signature of Function('serve', 76, 87)>",
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
|
||||
"signature": "<bound method Function.signature of Function('serve', 61, 69)>",
|
||||
"docstring": "Serve the documentation site with live-reload using MkDocs."
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2102,7 +2088,7 @@
|
||||
"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-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -2439,7 +2425,7 @@
|
||||
"name": "MCPRenderer",
|
||||
"kind": "class",
|
||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer",
|
||||
"signature": "<bound method Class.signature of Class('MCPRenderer', 8, 122)>",
|
||||
"signature": "<bound method Class.signature of Class('MCPRenderer', 8, 102)>",
|
||||
"docstring": "Renderer that emits MCP-native JSON resources from docforge models.",
|
||||
"members": {
|
||||
"name": {
|
||||
@@ -2453,8 +2439,8 @@
|
||||
"name": "generate_sources",
|
||||
"kind": "function",
|
||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer.generate_sources",
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 15, 53)>",
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 15, 49)>",
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -46,7 +46,7 @@
|
||||
"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-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -383,7 +383,7 @@
|
||||
"name": "MCPRenderer",
|
||||
"kind": "class",
|
||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer",
|
||||
"signature": "<bound method Class.signature of Class('MCPRenderer', 8, 122)>",
|
||||
"signature": "<bound method Class.signature of Class('MCPRenderer', 8, 102)>",
|
||||
"docstring": "Renderer that emits MCP-native JSON resources from docforge models.",
|
||||
"members": {
|
||||
"name": {
|
||||
@@ -397,8 +397,8 @@
|
||||
"name": "generate_sources",
|
||||
"kind": "function",
|
||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer.generate_sources",
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 15, 53)>",
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 15, 49)>",
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -210,7 +210,7 @@
|
||||
"name": "MCPRenderer",
|
||||
"kind": "class",
|
||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer",
|
||||
"signature": "<bound method Class.signature of Class('MCPRenderer', 8, 122)>",
|
||||
"signature": "<bound method Class.signature of Class('MCPRenderer', 8, 102)>",
|
||||
"docstring": "Renderer that emits MCP-native JSON resources from docforge models.",
|
||||
"members": {
|
||||
"name": {
|
||||
@@ -224,8 +224,8 @@
|
||||
"name": "generate_sources",
|
||||
"kind": "function",
|
||||
"path": "docforge.renderers.mcp_renderer.MCPRenderer.generate_sources",
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 15, 53)>",
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project.\n\nArgs:\n project: The project model to render.\n out_dir: Target directory for the generated JSON files."
|
||||
"signature": "<bound method Function.signature of Function('generate_sources', 15, 49)>",
|
||||
"docstring": "Generate MCP-compatible JSON resources and navigation for the project."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "doc-forge"
|
||||
version = "0.0.4"
|
||||
version = "0.0.2"
|
||||
description = "A renderer-agnostic Python documentation compiler"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.10"
|
||||
|
||||
@@ -10,7 +10,7 @@ def test_mcp_serve(
|
||||
|
||||
result = cli_runner.invoke(
|
||||
cli,
|
||||
["serve", "--mcp", "--module", "fake_module", "--out-dir", str(fake_mcp_docs)],
|
||||
["serve", "--mcp", "--out-dir", str(fake_mcp_docs)],
|
||||
)
|
||||
|
||||
assert result.exit_code == 0
|
||||
|
||||
Reference in New Issue
Block a user