Vishesh 'ironeagle' Bangotra
582b6809a0
- fix GSDFC spec contradictions in __init__ docstring (parenthesized types, fenced-block rule) and sync generated README - rewrite docstrings across loaders, models, nav, servers, renderers, cli; sync .pyi stubs - add pydoclint (google style) gate to dev extras and pyproject config - fix mcp nav resources doc:// -> docs:// - refresh docs/lib and docs/mcp, drop stale docforge/ duplicate group - update wiki pages and add GSDFC + MCP guides under 05_development
28 lines
778 B
Python
28 lines
778 B
Python
from pathlib import Path
|
|
|
|
from docforge.models import Module, Project
|
|
|
|
def discover_module_paths(
|
|
module_name: str,
|
|
project_root: Path | None = None,
|
|
) -> list[str]: ...
|
|
|
|
class GriffeLoader:
|
|
"""Griffe-based introspection loaders.
|
|
|
|
This is the only supported introspection backend in doc-forge.
|
|
Converts Griffe results into `Project`, `Module`, and `DocObject` models.
|
|
"""
|
|
|
|
def __init__(self) -> None: ...
|
|
def load_project(
|
|
self,
|
|
module_paths: list[str],
|
|
project_name: str | None = ...,
|
|
skip_import_errors: bool | None = ...,
|
|
) -> Project:
|
|
"""Load a documentation project from Python modules."""
|
|
|
|
def load_module(self, path: str) -> Module:
|
|
"""Load a single Python module by import path."""
|