spec
- dict[Any , Any ]
+ dict
@@ -1592,7 +1642,7 @@ site author.
OpenAPIMetadata
- OpenAPIMetadata OpenAPIMetadata
@@ -1643,7 +1693,7 @@ an
index.md embedding the swagger UI is generated alongside it.
spec
- dict[Any , Any ]
+ dict
diff --git a/doc-forge/lib/cli/commands/index.html b/doc-forge/lib/cli/commands/index.html
index c600a5f..7ab5312 100644
--- a/doc-forge/lib/cli/commands/index.html
+++ b/doc-forge/lib/cli/commands/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1396,6 +1446,17 @@
Summary
Command definitions for the doc-forge CLI.
Provides the CLI structure using Click, including build, serve, and tree commands.
+
+
+
+
+ Notes
+
+The build command validates requested modes before generating anything.
+--mkdocs, --api, and --wiki share a single MkDocs build; --mcp
+ generates a machine-readable bundle independently.
+
@@ -1455,9 +1516,9 @@
Build documentation artifacts.
-
This command performs the full documentation build pipeline:
-style of the selected platform, generates renderer-specific
-documentation sources, and optionally builds the final output.
+
This command runs the full documentation pipeline: it loads Python
+modules, generates renderer-specific documentation sources, and
+optionally builds or serves the final output.
Depending on the selected options, the build can target:
MkDocs static documentation sites for library reference docs
@@ -1467,6 +1528,16 @@ documentation sources, and optionally builds the final output.
+
+ Notes
+
+At least one of --mcp, --mkdocs, --wiki, or --api must be
+ provided.
+--mkdocs, --api, and --wiki are combined into a single MkDocs
+ build, while --mcp emits a machine-readable bundle.
+
+
Parameters:
@@ -1551,7 +1622,7 @@ documentation sources, and optionally builds the final output.
module
- Optional[str]
+ str | None
@@ -1565,7 +1636,7 @@ documentation sources, and optionally builds the final output.
openapi_spec
- Optional[Path ]
+ Path | None
@@ -1579,7 +1650,7 @@ documentation sources, and optionally builds the final output.
project_name
- Optional[str]
+ str | None
@@ -1593,7 +1664,7 @@ documentation sources, and optionally builds the final output.
site_name
- Optional[str]
+ str | None
@@ -1649,7 +1720,7 @@ documentation sources, and optionally builds the final output.
template
- Optional[Path ]
+ Path | None
@@ -1793,7 +1864,7 @@ documentation sources, and optionally builds the final output.
module
- Optional[str]
+ str | None
@@ -1909,7 +1980,7 @@ objects, including modules, classes, functions, and members.
project_name
- Optional[str]
+ str | None
diff --git a/doc-forge/lib/cli/index.html b/doc-forge/lib/cli/index.html
index 51e5d02..a919ac2 100644
--- a/doc-forge/lib/cli/index.html
+++ b/doc-forge/lib/cli/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
diff --git a/doc-forge/lib/cli/main/index.html b/doc-forge/lib/cli/main/index.html
index 515abe4..c5c626a 100644
--- a/doc-forge/lib/cli/main/index.html
+++ b/doc-forge/lib/cli/main/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
diff --git a/doc-forge/lib/cli/mcp_utils/index.html b/doc-forge/lib/cli/mcp_utils/index.html
index 8959a14..ecb7f2a 100644
--- a/doc-forge/lib/cli/mcp_utils/index.html
+++ b/doc-forge/lib/cli/mcp_utils/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1377,6 +1427,18 @@
Summary
Utilities for working with MCP in the doc-forge CLI.
+
+
+
+
+ Notes
+
+generate_resources produces the bundle consumed by MCPServer:
+ index.json, nav.json, and per-module resources under modules/.Resource URIs use the docs:// scheme: docs://index, docs://nav,
+ and docs://modules/{module}.
+
+
@@ -1442,7 +1504,7 @@ documentation generation.
project_name
- Optional[str]
+ str | None
diff --git a/doc-forge/lib/cli/mkdocs_utils/index.html b/doc-forge/lib/cli/mkdocs_utils/index.html
index 6fca381..e2e20aa 100644
--- a/doc-forge/lib/cli/mkdocs_utils/index.html
+++ b/doc-forge/lib/cli/mkdocs_utils/index.html
@@ -341,6 +341,10 @@
+
+
+
+
@@ -425,6 +429,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1411,6 +1461,17 @@
Summary
Utilities for working with MkDocs in the doc-forge CLI.
+
+
+
+
+ Notes
+
+A single generated mkdocs.yml serves lib, api, and wiki content with
+ merged navigation. Wiki navigation, when enabled, precedes every other
+ group and its index.md becomes the site Home.
+
+
@@ -1583,7 +1644,7 @@ and hand-written wiki content under a
wiki/ subdirectory.
template
- Optional[Path ]
+ Path | None
@@ -1627,7 +1688,7 @@ template replaces the built-in templates entirely.
modes
- Optional[Iterable [str]]
+ Iterable [str] | None
@@ -1644,7 +1705,7 @@ template.
site_description
- Optional[str]
+ str | None
@@ -1658,7 +1719,7 @@ template.
site_author
- Optional[str]
+ str | None
@@ -1672,7 +1733,7 @@ template.
wiki_dir
- Optional[Path ]
+ Path | None
@@ -1791,7 +1852,7 @@ documentation generation.
project_name
- Optional[str]
+ str | None
@@ -1805,7 +1866,7 @@ documentation generation.
module_is_source
- Optional[bool]
+ bool | None
@@ -1820,7 +1881,7 @@ rather than a nested module.
readme_dir
- Optional[Path ]
+ Path | None
diff --git a/doc-forge/lib/docforge/cli/api_utils/index.html b/doc-forge/lib/docforge/cli/api_utils/index.html
deleted file mode 100644
index 353d0ca..0000000
--- a/doc-forge/lib/docforge/cli/api_utils/index.html
+++ /dev/null
@@ -1,1707 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Api Utils - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Api Utils
-
-
-
-
-
-
-
-docforge.cli.api_utils
-
-
-
-
-
-
-
Summary
-
Utilities for building API documentation from an OpenAPI specification.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-
OpenAPIMetadata (
-site_name : str ,
-site_description : str | None ,
-site_author : str | None ,
-)
-
-
-
-
-
-
Metadata derived from the info block of an OpenAPI specification.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- site_name
- str
-
-
-
-
Spec title, used as the MkDocs site name.
-
-
-
- site_description
- str | None
-
-
-
-
Spec description, used as the site description.
-
-
-
- site_author
- str | None
-
-
-
-
Contact name (fallback: contact email), used as the
-site author.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-
derive_metadata ( spec : dict [ Any , Any ]) -> OpenAPIMetadata
-
-
-
-
-
Derive MkDocs site metadata from an OpenAPI spec info block.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- spec
- dict[Any , Any ]
-
-
-
-
Parsed OpenAPI specification.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-OpenAPIMetadata
- OpenAPIMetadata
-
-
-
Site name, description, and author derived from the spec.
-
-
-
-
-
-
-
-
-
-
-
-
-
-generate_api_sources
-
-
-
-
generate_api_sources (
-spec : dict [ Any , Any ], docs_dir : Path
-) -> None
-
-
-
-
-
Generate swagger-enabled Markdown sources and the spec copy.
-
The specification is written as openapi.json inside docs_dir and
-an index.md embedding the swagger UI is generated alongside it.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- spec
- dict[Any , Any ]
-
-
-
-
Parsed OpenAPI specification.
-
-
- required
-
-
-
- docs_dir
- Path
-
-
-
Directory (for example docs/api) where the swagger
-sources are written.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-load_openapi_spec
-
-
-
-
load_openapi_spec ( spec_path : Path ) -> dict [ Any , Any ]
-
-
-
-
-
Load and validate an OpenAPI specification from a JSON file.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- spec_path
- Path
-
-
-
Path to the OpenAPI JSON specification file.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-dict
- dict[Any , Any ]
-
-
-
-
The parsed OpenAPI specification.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- ClickException
-
-
-
If the file cannot be read or the info block is invalid.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/cli/commands/index.html b/doc-forge/lib/docforge/cli/commands/index.html
deleted file mode 100644
index aa9ad55..0000000
--- a/doc-forge/lib/docforge/cli/commands/index.html
+++ /dev/null
@@ -1,1879 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Commands - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Commands
-
-
-
-
-
-
-
-docforge.cli.commands
-
-
-
-
-
-
-
Summary
-
Command definitions for the doc-forge CLI.
-
Provides the CLI structure using Click, including build, serve, and tree commands.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
Functions
-
-
-
-
-
-build
-
-
-
-
build (
-mcp : bool ,
-mkdocs : bool ,
-api : bool ,
-wiki : bool ,
-module_is_source : bool ,
-module : str | None ,
-openapi_spec : Path | None ,
-project_name : str | None ,
-site_name : str | None ,
-docs_dir : Path ,
-wiki_dir : Path ,
-nav_file : Path ,
-template : Path | None ,
-mkdocs_yml : Path ,
-out_dir : Path ,
-) -> None
-
-
-
-
-
Build documentation artifacts.
-
This command performs the full documentation build pipeline:
-style of the selected platform, generates renderer-specific
-documentation sources, and optionally builds the final output.
-
Depending on the selected options, the build can target:
-
-MkDocs static documentation sites for library reference docs
-Swagger-enabled API docs generated from an OpenAPI spec
-Hand-written wiki pages included in the MkDocs site
-MCP structured documentation resources
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- mcp
- bool
-
-
-
-
Enable MCP documentation generation.
-
-
- required
-
-
-
- mkdocs
- bool
-
-
-
-
Enable MkDocs library documentation generation.
-
-
- required
-
-
-
- api
- bool
-
-
-
-
Enable API documentation generation from an OpenAPI spec.
-
-
- required
-
-
-
- wiki
- bool
-
-
-
-
Include a hand-written wiki directory in the MkDocs site.
-
-
- required
-
-
-
- module_is_source
- bool
-
-
-
-
Treat the specified module directory as the project root.
-
-
- required
-
-
-
- module
- Optional[str]
-
-
-
-
Python module import path to document.
-
-
- required
-
-
-
- openapi_spec
- Optional[Path ]
-
-
-
-
Path to the OpenAPI JSON specification used for API docs.
-
-
- required
-
-
-
- project_name
- Optional[str]
-
-
-
-
Optional override for the project name.
-
-
- required
-
-
-
- site_name
- Optional[str]
-
-
-
-
Display name for the MkDocs site.
-
-
- required
-
-
-
- docs_dir
- Path
-
-
-
Shared documentation root used as the MkDocs docs_dir.
-
-
- required
-
-
-
- wiki_dir
- Path
-
-
-
Directory containing hand-written wiki markdown files.
-
-
- required
-
-
-
- nav_file
- Path
-
-
-
Path to the navigation specification file.
-
-
- required
-
-
-
- template
- Optional[Path ]
-
-
-
-
Optional custom MkDocs configuration template.
-
-
- required
-
-
-
- mkdocs_yml
- Path
-
-
-
Output path for the generated MkDocs configuration.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Output directory for generated MCP resources.
-
-
- required
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- UsageError
-
-
-
If required options are missing or conflicting.
-
-
-
-
-
-
-
-
-
-
-
-
-
-serve
-
-
-
-
serve (
-mcp : bool ,
-mkdocs : bool ,
-module : str | None ,
-mkdocs_yml : Path ,
-out_dir : Path ,
-) -> None
-
-
-
-
-
Serve generated documentation locally.
-
Depending on the selected mode, this command starts either:
-
-A MkDocs development server for browsing documentation
-An MCP server exposing structured documentation resources
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- mcp
- bool
-
-
-
-
Serve documentation using the MCP server.
-
-
- required
-
-
-
- mkdocs
- bool
-
-
-
-
Serve the MkDocs development site.
-
-
- required
-
-
-
- module
- Optional[str]
-
-
-
-
Python module import path to serve via MCP.
-
-
- required
-
-
-
- mkdocs_yml
- Path
-
-
-
Path to the MkDocs configuration file.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Root directory containing MCP documentation resources.
-
-
- required
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- UsageError
-
-
-
If invalid or conflicting options are provided.
-
-
-
-
-
-
-
-
-
-
-
-
-
-tree
-
-
-
-
tree ( module : str , project_name : str | None ) -> None
-
-
-
-
-
Display the documentation object tree for a module.
-
This command introspects the specified module and prints a
-hierarchical representation of the discovered documentation
-objects, including modules, classes, functions, and members.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module
- str
-
-
-
-
Python module import path to introspect.
-
-
- required
-
-
-
- project_name
- Optional[str]
-
-
-
-
Optional name to display as the project root.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/cli/main/index.html b/doc-forge/lib/docforge/cli/main/index.html
deleted file mode 100644
index 3877d1d..0000000
--- a/doc-forge/lib/docforge/cli/main/index.html
+++ /dev/null
@@ -1,1357 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Main - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Main
-
-
-
-
-
-
-
-docforge.cli.main
-
-
-
-
-
-
-
Summary
-
Command-line entry point for the doc-forge CLI.
-
This module exposes the executable entry point that initializes the
-Click command group defined in docforge.cli.commands.
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-main
-
-
-
-
-
-
-
-
Run the doc-forge command-line interface.
-
This function initializes and executes the Click CLI application.
-It is used as the console entry point when invoking doc-forge
-from the command line.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/cli/mcp_utils/index.html b/doc-forge/lib/docforge/cli/mcp_utils/index.html
deleted file mode 100644
index 7c16802..0000000
--- a/doc-forge/lib/docforge/cli/mcp_utils/index.html
+++ /dev/null
@@ -1,1526 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Mcp Utils - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Mcp Utils
-
-
-
-
-
-
-
-docforge.cli.mcp_utils
-
-
-
-
-
-
-
Summary
-
Utilities for working with MCP in the doc-forge CLI.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
Functions
-
-
-
-
-
-generate_resources
-
-
-
-
generate_resources (
-module : str , project_name : str | None , out_dir : Path
-) -> None
-
-
-
-
-
Generate MCP documentation resources from a Python module.
-
The function performs project introspection, builds the internal
-documentation model, and renders MCP-compatible JSON resources
-to the specified output directory.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module
- str
-
-
-
-
Python module import path used as the entry point for
-documentation generation.
-
-
- required
-
-
-
- project_name
- Optional[str]
-
-
-
-
Optional override for the project name used in generated
-documentation metadata.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Directory where MCP resources (index.json, nav.json, and module data)
-will be written.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-serve
-
-
-
-
serve ( module : str , mcp_root : Path ) -> None
-
-
-
-
-
Start an MCP server for a pre-generated documentation bundle.
-
The server exposes documentation resources such as project metadata,
-navigation structure, and module documentation through MCP endpoints.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module
- str
-
-
-
-
Python module import path used to identify the served
-documentation instance.
-
-
- required
-
-
-
- mcp_root
- Path
-
-
-
Path to the directory containing the MCP documentation
-bundle (index.json, nav.json, and modules/).
-
-
- required
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- ClickException
-
-
-
If the MCP documentation bundle is missing required files or directories.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/cli/mkdocs_utils/index.html b/doc-forge/lib/docforge/cli/mkdocs_utils/index.html
deleted file mode 100644
index 8413897..0000000
--- a/doc-forge/lib/docforge/cli/mkdocs_utils/index.html
+++ /dev/null
@@ -1,1857 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Mkdocs Utils - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Mkdocs Utils
-
-
-
-
-
-
-
-docforge.cli.mkdocs_utils
-
-
-
-
-
-
-
Summary
-
Utilities for working with MkDocs in the doc-forge CLI.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
Functions
-
-
-
-
-
-build
-
-
-
-
build ( mkdocs_yml : Path ) -> None
-
-
-
-
-
Build the MkDocs documentation site.
-
This function loads the MkDocs configuration and runs the MkDocs
-build command to generate the final static documentation site.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- mkdocs_yml
- Path
-
-
-
Path to the mkdocs.yml configuration file.
-
-
- required
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- ClickException
-
-
-
If the configuration file does not exist.
-
-
-
-
-
-
-
-
-
-
-
-
-
-generate_config
-
-
-
-
generate_config (
-docs_dir : Path ,
-nav_file : Path ,
-template : Path | None ,
-out : Path ,
-site_name : str ,
-modes : Iterable [ str ] | None = None ,
-site_description : str | None = None ,
-site_author : str | None = None ,
-wiki_dir : Path | None = None ,
-) -> None
-
-
-
-
-
Generate an mkdocs.yml configuration file.
-
The configuration is created by combining a template configuration
-with a navigation structure derived from the docforge navigation
-specification (and, when a wiki directory is provided, from the wiki
-file structure).
-
The docs_dir is always written relative to the MkDocs root and is
-expected to be the shared documentation parent (for example docs),
-with generated sources nested under lib/ or api/ subdirectories
-and hand-written wiki content under a wiki/ subdirectory.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- docs_dir
- Path
-
-
-
Shared documentation root used as the MkDocs docs_dir.
-
-
- required
-
-
-
- nav_file
- Path
-
-
-
Path to the docforge.nav.yml navigation specification.
-
-
- required
-
-
-
- template
- Optional[Path ]
-
-
-
-
Optional path to a fully custom MkDocs configuration template.
-If not provided, built-in templates are merged; the provided
-template replaces the built-in templates entirely.
-
-
- required
-
-
-
- out
- Path
-
-
-
Destination path where the generated mkdocs.yml file will be written.
-
-
- required
-
-
-
- site_name
- str
-
-
-
-
Display name for the generated documentation site.
-
-
- required
-
-
-
- modes
- Optional[Iterable [str]]
-
-
-
-
Documentation modes to enable. Each mode contributes its own
-built-in template fragment (for example lib, api, or
-wiki), merged on top of the shared mkdocs.common.yml
-template.
-
-
- None
-
-
-
- site_description
- Optional[str]
-
-
-
-
Optional site description written into the configuration.
-
-
- None
-
-
-
- site_author
- Optional[str]
-
-
-
-
Optional site author written into the configuration.
-
-
- None
-
-
-
- wiki_dir
- Optional[Path ]
-
-
-
-
Optional path to a hand-written wiki directory (for example
-docs/wiki). When provided, the site navigation is derived
-from the wiki file structure and placed before the navigation
-groups defined in nav_file.
-
-
- None
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileError
-
-
-
If the navigation specification, template, or wiki directory
-cannot be found.
-
-
-
-
-
-
-
-
-
-
-
-
-
-generate_sources
-
-
-
-
generate_sources (
-module : str ,
-docs_dir : Path ,
-project_name : str | None = None ,
-module_is_source : bool | None = None ,
-readme_dir : Path | None = None ,
-) -> None
-
-
-
-
-
Generate MkDocs Markdown sources for a Python module.
-
This function introspects the specified module, builds the internal
-documentation model, and renders Markdown documentation files for
-use with MkDocs.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module
- str
-
-
-
-
Python module import path used as the entry point for
-documentation generation.
-
-
- required
-
-
-
- docs_dir
- Path
-
-
-
Directory where the generated Markdown files will be written.
-
-
- required
-
-
-
- project_name
- Optional[str]
-
-
-
-
Optional override for the project name used in documentation metadata.
-
-
- None
-
-
-
- module_is_source
- Optional[bool]
-
-
-
-
If True, treat the specified module directory as the project root
-rather than a nested module.
-
-
- None
-
-
-
- readme_dir
- Optional[Path ]
-
-
-
-
Directory where the generated README.md should be written. If not
-provided, defaults to the parent of docs_dir.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-serve
-
-
-
-
serve ( mkdocs_yml : Path ) -> None
-
-
-
-
-
Start an MkDocs development server with live reload.
-
The server watches documentation files and automatically reloads
-the site when changes are detected.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- mkdocs_yml
- Path
-
-
-
Path to the mkdocs.yml configuration file.
-
-
- required
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- ClickException
-
-
-
If the configuration file does not exist.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/index.html b/doc-forge/lib/docforge/index.html
deleted file mode 100644
index 6c71b09..0000000
--- a/doc-forge/lib/docforge/index.html
+++ /dev/null
@@ -1,3213 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Docforge - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Docforge
-
-
-
-
-
-
-
-docforge
-
-
-
-
-
-
-
Summary
-
Renderer-agnostic Python documentation compiler that converts Python docstrings
-into structured documentation for both humans (MkDocs) and machines (MCP / AI agents).
-
doc-forge statically analyzes source code, builds a semantic model of modules,
-classes, functions, and attributes, and renders that model into documentation
-outputs without executing user code.
-
-
Installation
-
Install using pip:
-
-
-
CLI usage
-
Generate an MkDocs site from a Python package:
-
build --mkdocs --module my_package
-
-
Generate MCP JSON documentation:
-
build --mcp --module my_package
-
-
Generate MkDocs site and MCP JSON documentation:
-
build --mcp --mkdocs --module my_package
-
-
Serve MkDocs locally:
-
serve --mkdocs --module my_package
-
-
Serve MCP locally:
-
serve --mcp --module my_package
-
-
-
Core concepts
-
Loader
-
Extracts symbols, signatures, and docstrings using static analysis.
-
Semantic model
-
Structured, renderer-agnostic representation of the API.
-
Renderer
-
Converts the semantic model into output formats such as MkDocs or MCP JSON.
-
Symbol
-
Any documentable object
-
-module
-class
-function
-method
-property
-attribute
-
-
-
Architecture
-
doc-forge follows a compiler architecture:
-
Front-end:
-
Static analysis of modules, classes, functions, type hints, and docstrings.
-
Middle-end:
-
Builds a semantic model describing symbols and relationships.
-
Back-end:
-
Renders documentation using interchangeable renderers.
-
This architecture ensures deterministic documentation generation.
-
-
Rendering pipeline
-
Typical flow:
-
1
-2
-3
-4
-5
-6
-7
-8
-9 Python package
- |
-Loader (static analysis)
- |
-Semantic model
- |
-Renderer
- |
-MkDocs site or MCP JSON
-
-
-
Google-Styled Doc-Forge Convention (GSDFC)
-
GSDFC defines how docstrings must be written so they render correctly in MkDocs and remain machine-parsable by doc-forge and AI tooling.
-
-Docstrings are the single source of truth.
-doc-forge compiles docstrings but does not generate documentation content.Documentation follows the Python import hierarchy.
-Every public symbol should have a complete and accurate docstring.
-
-
-
General rules
-
-Use Markdown headings at package and module level.
-Use Google-style structured sections at class, function, and method level.
-Use type hints in signatures instead of duplicating types in prose.
-Write summaries in imperative form.
-Sections are separated by ---
-
-
-
Notes subsection grouping
-
Group related information using labeled subsections.
-
Example:
-
1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13 Notes:
- **Guarantees:**
-
- - deterministic behavior
-
- **Lifecycle:**
-
- - created during initialization
- - reused across executions
-
- **Thread safety:**
-
- - safe for concurrent reads
-
-
-
-
-Use indentation for examples.
-Indent section contents using four spaces.
-Use code blocks for example code.
-
-
-
-
- Example
- Single example:
-Example:
-
- ```python
- foo = Foo("example")
- process(foo, multiplier=2)
- ```
-
Multiple examples:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13 Example:
- Create foo:
-
- ```python
- foo = Foo("example")
- ```
-
- Run engine:
-
- ```python
- engine = BarEngine([foo])
- engine.run()
- ```
-
Avoid fenced code blocks inside structured sections.
-
-
Separator rules
-
Use horizontal separators only at docstring root level to separate sections:
-
-
Allowed locations:
-
-package docstrings
-module docstrings
-major documentation sections
-
-
Do not use separators inside code sections.
-
-
Package docstrings
-
Package docstrings act as the documentation home page.
-
Recommended sections:
-
1
-2
-3
-4
-5
-6
-7
-8
-9 # Summary
-# Installation
-# Quick start
-# CLI usage
-# Core concepts
-# Architecture
-# Rendering pipeline
-# Examples
-# Notes
-
-
-
-
- Example
- Package Doc String:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30 '''
-# Summary
-
-Foo-bar processing framework.
-
-Provides tools for defining Foo objects and executing Bar pipelines.
-
----
-
-# Installation
-
-```bash
-pip install foo-bar
-```
-
----
-
-# Quick start
-
-```python
-from foobar import Foo, BarEngine
-
-foo = Foo("example")
-engine = BarEngine([foo])
-
-result = engine.run()
-```
-
----
-'''
-
-
Module docstrings
-
Module docstrings describe a subsystem.
-
Recommended sections:
-
# Summary
-# Examples
-# Notes
-
-
-
-
- Example
- Module Doc String:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23 '''
-# Summary
-
-Foo execution subsystem.
-
-Provides utilities for executing Foo objects through Bar stages.
-
----
-
-Example:
-
- ```python
- from foobar.engine import BarEngine
- from foobar.foo import Foo
-
- foo = Foo("example")
-
- engine = BarEngine([foo])
- engine.run()
- ```
-
----
-'''
-
-
Class docstrings
-
Class docstrings define object responsibility, lifecycle, and attributes.
-
Recommended sections:
-
Attributes:
-Notes:
-Example:
-Raises:
-
-
-
-
- Example
- Simple Foo:
-class Foo :
- '''
- Represents a unit of work.
- Attributes:
- name (str):
- Identifier of the foo instance.
- value (int):
- Numeric value associated with foo.
- Notes:
- Guarantees:
- - instances are immutable after creation
- Lifecycle:
- - create instance
- - pass to processing engine
- Example:
- Create and inspect a Foo:
- ```python
- foo = Foo("example", value=42)
- print(foo.name)
- ```
- '''
-
Complex Bar:
-class BarEngine :
- '''
- Executes Foo objects through Bar stages.
- Attributes:
- foos (tuple[Foo, ...]):
- Foo instances managed by the engine.
- Notes:
- Guarantees:
- - deterministic execution order
- Example:
- Run engine:
- ```python
- foo1 = Foo("a")
- foo2 = Foo("b")
- engine = BarEngine([foo1, foo2])
- engine.run()
- ```
- '''
-
-
Function and method docstrings
-
Function docstrings define API contracts.
-
Recommended sections:
-
Args:
-Returns:
-Raises:
-Yields:
-Notes:
-Example:
-
-
-
-
- Example
- Simple process method:
-def process ( foo : Foo , multiplier : int ) -> int :
- '''
- Process a Foo instance.
- Args:
- foo (Foo):
- Foo instance to process.
- multiplier (int):
- Value used to scale foo.
- Returns:
- int:
- Processed result.
- Raises:
- ValueError:
- If multiplier is negative.
- Notes:
- Guarantees:
- - foo is not modified
- Example:
- Process foo:
- ```python
- foo = Foo("example", value=10)
- result = process(foo, multiplier=2)
- print(result)
- ```
- '''
-
Multiple Examples:
-def combine ( foo_a : Foo , foo_b : Foo ) -> Foo :
- '''
- Combine two Foo instances.
- Args:
- foo_a (Foo):
- First foo.
- foo_b (Foo):
- Second foo.
- Returns:
- Foo:
- Combined foo.
- Example:
- Basic usage:
- ```python
- foo1 = Foo("a")
- foo2 = Foo("b")
- combined = combine(foo1, foo2)
- ```
- Pipeline usage:
- ```python
- engine = BarEngine([foo1, foo2])
- engine.run()
- ```
- '''
-
-
Property docstrings
-
Properties must document return values.
-
-
-
- Example
- Property Doc String:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18 ```python
-@property
-def foos(self) -> tuple[Foo, ...]:
- '''
- Return contained Foo instances.
-
- Returns:
- tuple[Foo, ...]:
- Stored foo objects.
-
- Example:
- ```python
- container = FooContainer()
-
- foos = container.foos
- ```
- '''
-```
-
-
Attribute documentation
-
Document attributes in class docstrings using Attributes:.
-
-
-
- Example
- Attribute Doc String:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12 ```python
-'''
-Represents a processing stage.
-
-Attributes:
- id (str):
- Unique identifier.
-
- enabled (bool):
- Whether the stage is active.
-'''
-```
-
-
Parsing guarantees
-
GSDFC ensures doc-forge can deterministically extract:
-
-symbol kind (module, class, function, property, attribute)
-symbol name
-parameters
-return values
-attributes
-examples
-structured Notes subsections
-
-
This enables:
-
-reliable MkDocs rendering
-deterministic MCP export
-accurate AI semantic interpretation
-
-
-
-
-
- Notes
-
-doc-forge never executes analyzed modules.
-Documentation is generated entirely through static analysis.
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-GriffeLoader
-
-
-
-
-
-
-
-
-
Load Python modules using Griffe and convert them into doc-forge models.
-
This loader uses the Griffe introspection engine to analyze Python source
-code and transform the extracted information into Project, Module,
-and DocObject instances used by doc-forge.
-
-
Initialize the Griffe-backed loader.
-
Creates an internal Griffe loader instance with dedicated collections
-for modules and source lines.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-load_module
-
-
-
-
load_module ( path : str ) -> Module
-
-
-
-
-
Load and convert a single Python module.
-
The module is introspected using Griffe and then transformed into
-a doc-forge Module model.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Dotted import path of the module.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Module
- Module
-
-
-
A populated Module instance.
-
-
-
-
-
-
-
-
-
-
-
-
-
-load_project
-
-
-
-
load_project (
-module_paths : list [ str ],
-project_name : str | None = None ,
-skip_import_errors : bool = None ,
-) -> Project
-
-
-
-
-
Load multiple modules and assemble them into a Project model.
-
Each module path is introspected and converted into a Module
-instance. All modules are then aggregated into a single Project
-object.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module_paths
- List[str]
-
-
-
-
List of dotted module import paths to load.
-
-
- required
-
-
-
- project_name
- str
-
-
-
-
Optional override for the project name. Defaults to the top-level
-name of the first module.
-
-
- None
-
-
-
- skip_import_errors
- bool
-
-
-
-
If True, modules that fail to load will be skipped instead of raising an error.
-
-
- None
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Project
- Project
-
-
-
A populated Project instance containing the loaded modules.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- ValueError
-
-
-
-
If no module paths are provided.
-
-
-
-
- ImportError
-
-
-
-
If a module fails to load and skip_import_errors is False.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-MCPRenderer
-
-
-
-
-
-
-
-
-
Renderer that generates MCP-compatible documentation resources.
-
This renderer converts doc-forge project models into structured JSON
-resources suitable for consumption by systems implementing the Model
-Context Protocol (MCP).
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-generate_sources
-
-
-
-
generate_sources ( project : Project , out_dir : Path ) -> None
-
-
-
-
-
Generate MCP documentation resources for a project.
-
The renderer serializes each module into a JSON resource and produces
-supporting metadata files such as nav.json and index.json.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Documentation project model to render.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Directory where MCP resources will be written.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-MkDocsRenderer
-
-
-
-
-
-
-
-
-
Renderer that produces Markdown documentation for MkDocs.
-
Generated pages use mkdocstrings directives to reference Python modules,
-allowing MkDocs to render API documentation dynamically.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-generate_readme
-
-
-
-
generate_readme (
-project : Project ,
-docs_dir : Path ,
-module_is_source : bool | None = None ,
-readme_dir : Path | None = None ,
-) -> None
-
-
-
-
-
Generate a README.md file from the root module docstring.
-
Behavior:
-
-If module_is_source is True, README.md is written to the project
- root directory.
-If False, README generation is currently not implemented.
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Project model containing documentation metadata.
-
-
- required
-
-
-
- docs_dir
- Path
-
-
-
Directory containing generated documentation sources.
-
-
- required
-
-
-
- module_is_source
- Optional[bool]
-
-
-
-
Whether the module is treated as the project source root.
-
-
- None
-
-
-
- readme_dir
- Optional[Path ]
-
-
-
-
Directory where the generated README.md should be written.
-Defaults to the parent of docs_dir.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-generate_sources
-
-
-
-
generate_sources (
-project : Project ,
-out_dir : Path ,
-module_is_source : bool | None = None ,
-) -> None
-
-
-
-
-
Generate Markdown documentation files for a project.
-
This method renders a documentation structure from the provided
-project model and writes the resulting Markdown files to the
-specified output directory.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Project model containing modules to document.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Directory where generated Markdown files will be written.
-
-
- required
-
-
-
- module_is_source
- bool
-
-
-
-
If True, treat the specified module as the documentation root
-rather than nesting it inside a folder.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-discover_module_paths
-
-
-
-
discover_module_paths (
-module_name : str , project_root : Path | None = None
-) -> list [ str ]
-
-
-
-
-
Discover Python modules within a package directory.
-
The function scans the filesystem for .py files inside the specified
-package and converts them into dotted module import paths.
-
Discovery rules:
-
-Directories containing __init__.py are treated as packages.
-Each .py file is treated as a module.
-Results are returned as dotted import paths.
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module_name
- str
-
-
-
-
Top-level package name to discover modules from.
-
-
- required
-
-
-
- project_root
- Path
-
-
-
Root directory used to resolve module paths. If not provided, the
-current working directory is used.
-
-
- None
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[str]
-
-
-
-
List[str]:
-A sorted list of unique dotted module import paths.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the specified package directory does not exist.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/loaders/griffe_loader/index.html b/doc-forge/lib/docforge/loaders/griffe_loader/index.html
deleted file mode 100644
index 2ad0059..0000000
--- a/doc-forge/lib/docforge/loaders/griffe_loader/index.html
+++ /dev/null
@@ -1,1783 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Griffe Loader - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Griffe Loader
-
-
-
-
-
-
-
-docforge.loaders.griffe_loader
-
-
-
-
-
-
-
Summary
-
Utilities for loading and introspecting Python modules using Griffe.
-
This module provides the GriffeLoader class and helper utilities used to
-discover Python modules, introspect their structure, and convert the results
-into doc-forge documentation models.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-GriffeLoader
-
-
-
-
-
-
-
-
-
Load Python modules using Griffe and convert them into doc-forge models.
-
This loader uses the Griffe introspection engine to analyze Python source
-code and transform the extracted information into Project, Module,
-and DocObject instances used by doc-forge.
-
-
Initialize the Griffe-backed loader.
-
Creates an internal Griffe loader instance with dedicated collections
-for modules and source lines.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-load_module
-
-
-
-
load_module ( path : str ) -> Module
-
-
-
-
-
Load and convert a single Python module.
-
The module is introspected using Griffe and then transformed into
-a doc-forge Module model.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Dotted import path of the module.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Module
- Module
-
-
-
A populated Module instance.
-
-
-
-
-
-
-
-
-
-
-
-
-
-load_project
-
-
-
-
load_project (
-module_paths : list [ str ],
-project_name : str | None = None ,
-skip_import_errors : bool = None ,
-) -> Project
-
-
-
-
-
Load multiple modules and assemble them into a Project model.
-
Each module path is introspected and converted into a Module
-instance. All modules are then aggregated into a single Project
-object.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module_paths
- List[str]
-
-
-
-
List of dotted module import paths to load.
-
-
- required
-
-
-
- project_name
- str
-
-
-
-
Optional override for the project name. Defaults to the top-level
-name of the first module.
-
-
- None
-
-
-
- skip_import_errors
- bool
-
-
-
-
If True, modules that fail to load will be skipped instead of raising an error.
-
-
- None
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Project
- Project
-
-
-
A populated Project instance containing the loaded modules.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- ValueError
-
-
-
-
If no module paths are provided.
-
-
-
-
- ImportError
-
-
-
-
If a module fails to load and skip_import_errors is False.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-discover_module_paths
-
-
-
-
discover_module_paths (
-module_name : str , project_root : Path | None = None
-) -> list [ str ]
-
-
-
-
-
Discover Python modules within a package directory.
-
The function scans the filesystem for .py files inside the specified
-package and converts them into dotted module import paths.
-
Discovery rules:
-
-Directories containing __init__.py are treated as packages.
-Each .py file is treated as a module.
-Results are returned as dotted import paths.
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module_name
- str
-
-
-
-
Top-level package name to discover modules from.
-
-
- required
-
-
-
- project_root
- Path
-
-
-
Root directory used to resolve module paths. If not provided, the
-current working directory is used.
-
-
- None
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[str]
-
-
-
-
List[str]:
-A sorted list of unique dotted module import paths.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the specified package directory does not exist.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/loaders/index.html b/doc-forge/lib/docforge/loaders/index.html
deleted file mode 100644
index d2c5d70..0000000
--- a/doc-forge/lib/docforge/loaders/index.html
+++ /dev/null
@@ -1,1807 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Loaders - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Loaders
-
-
-
-
-
-
-
-docforge.loaders
-
-
-
-
-
-
-
Summary
-
Loader layer for doc-forge.
-
The docforge.loaders package is responsible for discovering Python modules
-and extracting documentation data using static analysis.
-
-
Overview
-
This layer converts Python source code into an intermediate documentation
-model used by doc-forge. It performs module discovery, introspection, and
-initial filtering before the data is passed to the core documentation models.
-
Core capabilities include:
-
-Module discovery – Locate Python modules and packages within a project.Static introspection – Parse docstrings, signatures, and object
- hierarchies using the griffe library without executing the code.Public API filtering – Exclude private members (names prefixed with
- _) to produce clean public documentation structures.
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-GriffeLoader
-
-
-
-
-
-
-
-
-
Load Python modules using Griffe and convert them into doc-forge models.
-
This loader uses the Griffe introspection engine to analyze Python source
-code and transform the extracted information into Project, Module,
-and DocObject instances used by doc-forge.
-
-
Initialize the Griffe-backed loader.
-
Creates an internal Griffe loader instance with dedicated collections
-for modules and source lines.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-load_module
-
-
-
-
load_module ( path : str ) -> Module
-
-
-
-
-
Load and convert a single Python module.
-
The module is introspected using Griffe and then transformed into
-a doc-forge Module model.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Dotted import path of the module.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Module
- Module
-
-
-
A populated Module instance.
-
-
-
-
-
-
-
-
-
-
-
-
-
-load_project
-
-
-
-
load_project (
-module_paths : list [ str ],
-project_name : str | None = None ,
-skip_import_errors : bool = None ,
-) -> Project
-
-
-
-
-
Load multiple modules and assemble them into a Project model.
-
Each module path is introspected and converted into a Module
-instance. All modules are then aggregated into a single Project
-object.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module_paths
- List[str]
-
-
-
-
List of dotted module import paths to load.
-
-
- required
-
-
-
- project_name
- str
-
-
-
-
Optional override for the project name. Defaults to the top-level
-name of the first module.
-
-
- None
-
-
-
- skip_import_errors
- bool
-
-
-
-
If True, modules that fail to load will be skipped instead of raising an error.
-
-
- None
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Project
- Project
-
-
-
A populated Project instance containing the loaded modules.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- ValueError
-
-
-
-
If no module paths are provided.
-
-
-
-
- ImportError
-
-
-
-
If a module fails to load and skip_import_errors is False.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-discover_module_paths
-
-
-
-
discover_module_paths (
-module_name : str , project_root : Path | None = None
-) -> list [ str ]
-
-
-
-
-
Discover Python modules within a package directory.
-
The function scans the filesystem for .py files inside the specified
-package and converts them into dotted module import paths.
-
Discovery rules:
-
-Directories containing __init__.py are treated as packages.
-Each .py file is treated as a module.
-Results are returned as dotted import paths.
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module_name
- str
-
-
-
-
Top-level package name to discover modules from.
-
-
- required
-
-
-
- project_root
- Path
-
-
-
Root directory used to resolve module paths. If not provided, the
-current working directory is used.
-
-
- None
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[str]
-
-
-
-
List[str]:
-A sorted list of unique dotted module import paths.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the specified package directory does not exist.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/models/index.html b/doc-forge/lib/docforge/models/index.html
deleted file mode 100644
index f18f1a9..0000000
--- a/doc-forge/lib/docforge/models/index.html
+++ /dev/null
@@ -1,2597 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Models - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Models
-
-
-
-
-
-
-
-docforge.models
-
-
-
-
-
-
-
Summary
-
Model layer for doc-forge.
-
The docforge.models package defines the core data structures used to
-represent Python source code as a structured documentation model.
-
-
Overview
-
The model layer forms the central intermediate representation used throughout
-doc-forge. Python modules and objects discovered during introspection are
-converted into a hierarchy of documentation models that can later be rendered
-into different documentation formats.
-
Key components:
-
-Project – Root container representing an entire documented codebase.Module – Representation of a Python module or package containing
- documented members.DocObject – Recursive structure representing Python objects such as
- classes, functions, methods, and attributes.
-
These models are intentionally renderer-agnostic , allowing the same
-documentation structure to be transformed into multiple output formats
-(e.g., MkDocs, MCP, or other renderers).
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-DocObject
-
-
-
-
DocObject (
-name : str ,
-kind : str ,
-path : str ,
-signature : str | None = None ,
-docstring : str | None = None ,
-)
-
-
-
-
-
-
Representation of a documented Python object.
-
A DocObject models a single Python entity discovered during
-introspection. Objects may contain nested members, allowing the structure
-of modules, classes, and other containers to be represented recursively.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- name
- str
-
-
-
-
Local name of the object.
-
-
-
- kind
- str
-
-
-
-
Type of object (for example class, function, method, or attribute).
-
-
-
- path
- str
-
-
-
-
Fully qualified dotted path to the object.
-
-
-
- signature
- Optional[str]
-
-
-
-
Callable signature if the object represents a callable.
-
-
-
- docstring
- Optional[str]
-
-
-
-
Raw docstring text extracted from the source code.
-
-
-
- members
- Dict[str, DocObject ]
-
-
-
-
Mapping of member names to child DocObject instances.
-
-
-
-
-
-
Initialize a DocObject instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- name
- str
-
-
-
-
Local name of the object.
-
-
- required
-
-
-
- kind
- str
-
-
-
-
Object type identifier (for example class or function).
-
-
- required
-
-
-
- path
- str
-
-
-
-
Fully qualified dotted path of the object.
-
-
- required
-
-
-
- signature
- Optional[str]
-
-
-
-
Callable signature if applicable.
-
-
- None
-
-
-
- docstring
- Optional[str]
-
-
-
-
Documentation string associated with the object.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-add_member
-
-
-
-
add_member ( obj : DocObject ) -> None
-
-
-
-
-
Add a child documentation object.
-
This is typically used when attaching methods to classes or
-nested objects to their parent containers.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- obj
- DocObject
-
-
-
Documentation object to add as a member.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_all_members
-
-
-
-
get_all_members () -> Iterable [ DocObject ]
-
-
-
-
-
Return all child members of the object.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterable [DocObject ]
-
-
-
Iterable[DocObject]:
-An iterable of DocObject instances representing nested members.
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_member
-
-
-
-
get_member ( name : str ) -> DocObject
-
-
-
-
-
Retrieve a member object by name.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- name
- str
-
-
-
-
Name of the member to retrieve.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-DocObject
- DocObject
-
-
-
The corresponding DocObject instance.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- KeyError
-
-
-
-
If the member does not exist.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module
-
-
-
-
Module ( path : str , docstring : str | None = None )
-
-
-
-
-
-
Representation of a documented Python module or package.
-
A Module stores metadata about the module itself and maintains a
-collection of top-level documentation objects discovered during
-introspection.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- path
- str
-
-
-
-
Dotted import path of the module.
-
-
-
- docstring
- Optional[str]
-
-
-
-
Module-level documentation string, if present.
-
-
-
- members
- Dict[str, DocObject ]
-
-
-
-
Mapping of object names to their corresponding DocObject representations.
-
-
-
-
-
-
Initialize a Module instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Dotted import path identifying the module.
-
-
- required
-
-
-
- docstring
- Optional[str]
-
-
-
-
Module-level documentation text, if available.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-add_object
-
-
-
-
add_object ( obj : DocObject ) -> None
-
-
-
-
-
Add a documented object to the module.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- obj
- DocObject
-
-
-
Documentation object to register as a top-level member of the module.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_all_objects
-
-
-
-
get_all_objects () -> Iterable [ DocObject ]
-
-
-
-
-
Return all top-level documentation objects in the module.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterable [DocObject ]
-
-
-
Iterable[DocObject]:
-An iterable of DocObject instances representing the module's public members.
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_object
-
-
-
-
get_object ( name : str ) -> DocObject
-
-
-
-
-
Retrieve a documented object by name.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- name
- str
-
-
-
-
Name of the object to retrieve.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-DocObject
- DocObject
-
-
-
The corresponding DocObject instance.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- KeyError
-
-
-
-
If no object with the given name exists.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Project
-
-
-
-
-
-
-
-
-
Representation of a documentation project.
-
A Project serves as the root container for all modules discovered during
-introspection. Each module is stored by its dotted import path.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- name
- str
-
-
-
-
-
-
- modules
- Dict[str, Module ]
-
-
-
-
Mapping of module paths to Module instances.
-
-
-
-
-
-
Initialize a Project instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- name
- str
-
-
-
-
Name used to identify the documentation project.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-add_module
-
-
-
-
add_module ( module : Module ) -> None
-
-
-
-
-
Register a module in the project.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module
- Module
-
-
-
Module instance to add to the project.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_all_modules
-
-
-
-
get_all_modules () -> Iterable [ Module ]
-
-
-
-
-
Return all modules contained in the project.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterable [Module ]
-
-
-
Iterable[Module]:
-An iterable of Module instances.
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_module
-
-
-
-
get_module ( path : str ) -> Module
-
-
-
-
-
Retrieve a module by its dotted path.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Fully qualified dotted module path (for example pkg.module).
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Module
- Module
-
-
-
The corresponding Module instance.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- KeyError
-
-
-
-
If the module does not exist in the project.
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_module_list
-
-
-
-
get_module_list () -> list [ str ]
-
-
-
-
-
Return the list of module import paths.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[str]
-
-
-
-
list[str]:
-A list containing the dotted paths of all modules in the project.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/models/module/index.html b/doc-forge/lib/docforge/models/module/index.html
deleted file mode 100644
index 334e7ad..0000000
--- a/doc-forge/lib/docforge/models/module/index.html
+++ /dev/null
@@ -1,1703 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Module - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module
-
-
-
-
-
-
-
-docforge.models.module
-
-
-
-
-
-
-
Summary
-
Documentation model representing a Python module or package.
-
This module defines the Module class used in the doc-forge documentation
-model. A Module acts as a container for top-level documented objects
-(classes, functions, variables, and other members) discovered during
-introspection.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-Module
-
-
-
-
Module ( path : str , docstring : str | None = None )
-
-
-
-
-
-
Representation of a documented Python module or package.
-
A Module stores metadata about the module itself and maintains a
-collection of top-level documentation objects discovered during
-introspection.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- path
- str
-
-
-
-
Dotted import path of the module.
-
-
-
- docstring
- Optional[str]
-
-
-
-
Module-level documentation string, if present.
-
-
-
- members
- Dict[str, DocObject ]
-
-
-
-
Mapping of object names to their corresponding DocObject representations.
-
-
-
-
-
-
Initialize a Module instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Dotted import path identifying the module.
-
-
- required
-
-
-
- docstring
- Optional[str]
-
-
-
-
Module-level documentation text, if available.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-add_object
-
-
-
-
add_object ( obj : DocObject ) -> None
-
-
-
-
-
Add a documented object to the module.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- obj
- DocObject
-
-
-
Documentation object to register as a top-level member of the module.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_all_objects
-
-
-
-
get_all_objects () -> Iterable [ DocObject ]
-
-
-
-
-
Return all top-level documentation objects in the module.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterable [DocObject ]
-
-
-
Iterable[DocObject]:
-An iterable of DocObject instances representing the module's public members.
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_object
-
-
-
-
get_object ( name : str ) -> DocObject
-
-
-
-
-
Retrieve a documented object by name.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- name
- str
-
-
-
-
Name of the object to retrieve.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-DocObject
- DocObject
-
-
-
The corresponding DocObject instance.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- KeyError
-
-
-
-
If no object with the given name exists.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/models/object/index.html b/doc-forge/lib/docforge/models/object/index.html
deleted file mode 100644
index e1a51ae..0000000
--- a/doc-forge/lib/docforge/models/object/index.html
+++ /dev/null
@@ -1,1792 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Object - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Object
-
-
-
-
-
-
-
-docforge.models.object
-
-
-
-
-
-
-
Summary
-
Documentation model representing individual Python objects.
-
This module defines the DocObject class, the fundamental recursive unit of
-the doc-forge documentation model. Each DocObject represents a Python
-entity such as a class, function, method, or attribute, and may contain nested
-members that form a hierarchical documentation structure.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-DocObject
-
-
-
-
DocObject (
-name : str ,
-kind : str ,
-path : str ,
-signature : str | None = None ,
-docstring : str | None = None ,
-)
-
-
-
-
-
-
Representation of a documented Python object.
-
A DocObject models a single Python entity discovered during
-introspection. Objects may contain nested members, allowing the structure
-of modules, classes, and other containers to be represented recursively.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- name
- str
-
-
-
-
Local name of the object.
-
-
-
- kind
- str
-
-
-
-
Type of object (for example class, function, method, or attribute).
-
-
-
- path
- str
-
-
-
-
Fully qualified dotted path to the object.
-
-
-
- signature
- Optional[str]
-
-
-
-
Callable signature if the object represents a callable.
-
-
-
- docstring
- Optional[str]
-
-
-
-
Raw docstring text extracted from the source code.
-
-
-
- members
- Dict[str, DocObject ]
-
-
-
-
Mapping of member names to child DocObject instances.
-
-
-
-
-
-
Initialize a DocObject instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- name
- str
-
-
-
-
Local name of the object.
-
-
- required
-
-
-
- kind
- str
-
-
-
-
Object type identifier (for example class or function).
-
-
- required
-
-
-
- path
- str
-
-
-
-
Fully qualified dotted path of the object.
-
-
- required
-
-
-
- signature
- Optional[str]
-
-
-
-
Callable signature if applicable.
-
-
- None
-
-
-
- docstring
- Optional[str]
-
-
-
-
Documentation string associated with the object.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-add_member
-
-
-
-
add_member ( obj : DocObject ) -> None
-
-
-
-
-
Add a child documentation object.
-
This is typically used when attaching methods to classes or
-nested objects to their parent containers.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- obj
- DocObject
-
-
-
Documentation object to add as a member.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_all_members
-
-
-
-
get_all_members () -> Iterable [ DocObject ]
-
-
-
-
-
Return all child members of the object.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterable [DocObject ]
-
-
-
Iterable[DocObject]:
-An iterable of DocObject instances representing nested members.
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_member
-
-
-
-
get_member ( name : str ) -> DocObject
-
-
-
-
-
Retrieve a member object by name.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- name
- str
-
-
-
-
Name of the member to retrieve.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-DocObject
- DocObject
-
-
-
The corresponding DocObject instance.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- KeyError
-
-
-
-
If the member does not exist.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/models/project/index.html b/doc-forge/lib/docforge/models/project/index.html
deleted file mode 100644
index d4a56f0..0000000
--- a/doc-forge/lib/docforge/models/project/index.html
+++ /dev/null
@@ -1,1728 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Project - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Project
-
-
-
-
-
-
-
-docforge.models.project
-
-
-
-
-
-
-
Summary
-
Documentation model representing a project.
-
This module defines the Project class, the top-level container used by
-doc-forge to represent a documented codebase. A Project aggregates multiple
-modules and provides access to them through a unified interface.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-Project
-
-
-
-
-
-
-
-
-
Representation of a documentation project.
-
A Project serves as the root container for all modules discovered during
-introspection. Each module is stored by its dotted import path.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- name
- str
-
-
-
-
-
-
- modules
- Dict[str, Module ]
-
-
-
-
Mapping of module paths to Module instances.
-
-
-
-
-
-
Initialize a Project instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- name
- str
-
-
-
-
Name used to identify the documentation project.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-add_module
-
-
-
-
add_module ( module : Module ) -> None
-
-
-
-
-
Register a module in the project.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- module
- Module
-
-
-
Module instance to add to the project.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_all_modules
-
-
-
-
get_all_modules () -> Iterable [ Module ]
-
-
-
-
-
Return all modules contained in the project.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterable [Module ]
-
-
-
Iterable[Module]:
-An iterable of Module instances.
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_module
-
-
-
-
get_module ( path : str ) -> Module
-
-
-
-
-
Retrieve a module by its dotted path.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Fully qualified dotted module path (for example pkg.module).
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Module
- Module
-
-
-
The corresponding Module instance.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- KeyError
-
-
-
-
If the module does not exist in the project.
-
-
-
-
-
-
-
-
-
-
-
-
-
-get_module_list
-
-
-
-
get_module_list () -> list [ str ]
-
-
-
-
-
Return the list of module import paths.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[str]
-
-
-
-
list[str]:
-A list containing the dotted paths of all modules in the project.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/nav/index.html b/doc-forge/lib/docforge/nav/index.html
deleted file mode 100644
index b139caf..0000000
--- a/doc-forge/lib/docforge/nav/index.html
+++ /dev/null
@@ -1,2499 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Nav - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nav
-
-
-
-
-
-
-
-docforge.nav
-
-
-
-
-
-
-
Navigation layer for doc-forge.
-
The docforge.nav package manages the relationship between the logical
-documentation structure defined by the user and the physical documentation
-files generated on disk.
-
-
Workflow
-
-Specification – Users define navigation intent in docforge.nav.yml.Resolution – resolve_nav expands patterns and matches them against
- generated Markdown files.Emission – MkDocsNavEmitter converts the resolved structure into
- the YAML navigation format required by mkdocs.yml.
-
This layer separates documentation organization from the underlying source
-code layout, enabling flexible grouping, ordering, and navigation structures
-independent of module hierarchy.
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MkDocsNavEmitter
-
-
-
-
-
-
-
-
-
Emit MkDocs navigation structures from resolved navigation data.
-
The emitter transforms a ResolvedNav object into the YAML-compatible
-list structure expected by the MkDocs nav configuration field.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-emit
-
-
-
-
emit ( nav : ResolvedNav ) -> list [ dict [ str , Any ]]
-
-
-
-
-
Generate a navigation structure for mkdocs.yml.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- nav
- ResolvedNav
-
-
-
Resolved navigation data describing documentation groups
-and their associated Markdown files.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
A list of dictionaries representing the MkDocs navigation layout.
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
Each dictionary maps a navigation label to a page or a list of
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-NavSpec
-
-
-
-
NavSpec (
-home : str | None ,
-groups : dict [ str , list [ str ]],
-icon : dict [ str , str ] | None = None ,
-)
-
-
-
-
-
-
Parsed representation of a navigation specification.
-
A NavSpec describes the intended documentation navigation layout before
-it is resolved against the filesystem.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- home
- str | None
-
-
-
-
Relative path to the documentation home page (for example
-index.md).
-
-
-
- groups
- dict[str, list[str]]
-
-
-
-
Mapping of navigation group titles to lists of file patterns
-or glob expressions.
-
-
-
- icon
-
-
-
-
Optional mapping of theme icon entries (for example
-{"logo": "material/code-tags"}) injected into the MkDocs
-theme as theme.icon.
-
-
-
-
-
-
Initialize a NavSpec instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- home
- str | None
-
-
-
-
Relative path to the home document.
-
-
- required
-
-
-
- groups
- dict[str, list[str]]
-
-
-
-
Mapping of group names to lists of path patterns
-(glob expressions).
-
-
- required
-
-
-
- icon
- dict[str, str] | None
-
-
-
-
Optional mapping of theme icon entries applied to the
-generated MkDocs configuration.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-all_patterns
-
-
-
-
all_patterns () -> list [ str ]
-
-
-
-
-
Return all path patterns referenced by the specification.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[str]
-
-
-
-
A list containing the home document (if defined) and all
-
-
-
-
- list[str]
-
-
-
-
group pattern entries.
-
-
-
-
-
-
-
-
-
-
-
-
-
-load
-
-
-
- classmethod
-
-
-
load ( path : Path ) -> NavSpec
-
-
-
-
-
Load a navigation specification from a YAML file.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- Path
-
-
-
Filesystem path to the navigation specification file.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- NavSpec
-
-
-
A NavSpec instance representing the parsed configuration.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the specified file does not exist.
-
-
-
-
- ValueError
-
-
-
-
If the file contents are not a valid navigation
-specification.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-ResolvedNav
-
-
-
-
ResolvedNav (
-home : str | None ,
-groups : dict [ str , list [ Path ]],
-docs_root : Path | None = None ,
-)
-
-
-
-
-
-
Resolved navigation structure.
-
A ResolvedNav represents navigation data after glob patterns have been
-expanded and paths validated against the filesystem.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- home
- str | None
-
-
-
-
Relative path to the documentation home page.
-
-
-
- groups
- dict[str, list[Path ]]
-
-
-
-
Mapping of navigation group titles to lists of resolved
-documentation file paths.
-
-
-
-
-
-
Initialize a ResolvedNav instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- home
- str | None
-
-
-
-
Relative path to the home page within the documentation root.
-
-
- required
-
-
-
- groups
- dict[str, list[Path ]]
-
-
-
-
Mapping of group titles to resolved documentation file paths.
-
-
- required
-
-
-
- docs_root
- Path | None
-
-
-
Root directory of the documentation source files.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-all_files
-
-
-
-
all_files () -> Iterable [ Path ]
-
-
-
-
-
Iterate over all files referenced by the navigation structure.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterable [Path ]
-
-
-
An iterable of Path objects representing documentation files.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- RuntimeError
-
-
-
-
If the home page is defined but the documentation
-root is not available for resolution.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-build_wiki_nav
-
-
-
-
build_wiki_nav ( wiki_dir : Path ) -> list [ dict [ str , Any ]]
-
-
-
-
-
Derive an MkDocs navigation block from a wiki directory.
-
Returned paths are relative to the parent of wiki_dir and carry the
-wiki directory name as their leading component (for example
-wiki/01_overview.md when the wiki lives at docs/wiki). This makes
-the result directly usable in an MkDocs nav block with
-
-index.md at the wiki root becomes the Home entry.Page labels are derived from filenames: numeric order prefixes such as
- 01_ or 02- are stripped, separators are replaced with spaces, and
- names are title-cased (01_overview.md becomes Overview).
-Subdirectories become nested navigation groups. A nested index.md is
- rendered as the section root placed first inside the group.
-Only .md files are considered; hidden entries are ignored.
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- wiki_dir
- Path
-
-
-
Path to the hand-written wiki directory, for example docs/wiki.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
List[Dict[str, Any]]:
-Navigation entries compatible with the MkDocs nav configuration.
-The list is empty if the wiki contains no Markdown files.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the wiki directory does not exist.
-
-
-
-
-
-
-
-
-
-
-
-
-
-load_nav_spec
-
-
-
-
load_nav_spec ( path : Path ) -> NavSpec
-
-
-
-
-
Load a navigation specification file.
-
This helper function reads a YAML navigation file and constructs a
-corresponding NavSpec instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- Path
-
-
-
Path to the navigation specification file.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- NavSpec
-
-
-
A NavSpec instance representing the parsed specification.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the specification file does not exist.
-
-
-
-
- ValueError
-
-
-
-
If the YAML structure is invalid.
-
-
-
-
-
-
-
-
-
-
-
-
-
-resolve_nav
-
-
-
-
resolve_nav ( spec : NavSpec , docs_root : Path ) -> ResolvedNav
-
-
-
-
-
Resolve a navigation specification against the filesystem.
-
The function expands glob patterns defined in a NavSpec and verifies
-that referenced documentation files exist within the documentation root.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- spec
- NavSpec
-
-
-
Navigation specification describing documentation layout.
-
-
- required
-
-
-
- docs_root
- Path
-
-
-
Root directory containing documentation Markdown files.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- ResolvedNav
-
-
-
A ResolvedNav instance containing validated navigation paths.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the documentation root does not exist or a
-navigation pattern does not match any files.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/nav/mkdocs/index.html b/doc-forge/lib/docforge/nav/mkdocs/index.html
deleted file mode 100644
index 7a1e961..0000000
--- a/doc-forge/lib/docforge/nav/mkdocs/index.html
+++ /dev/null
@@ -1,1487 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Mkdocs - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Mkdocs
-
-
-
-
-
-
-
-docforge.nav.mkdocs
-
-
-
-
-
-
-
MkDocs navigation emitter.
-
This module provides the MkDocsNavEmitter class, which converts a
-ResolvedNav instance into the navigation structure required by the
-MkDocs nav configuration.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MkDocsNavEmitter
-
-
-
-
-
-
-
-
-
Emit MkDocs navigation structures from resolved navigation data.
-
The emitter transforms a ResolvedNav object into the YAML-compatible
-list structure expected by the MkDocs nav configuration field.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-emit
-
-
-
-
emit ( nav : ResolvedNav ) -> list [ dict [ str , Any ]]
-
-
-
-
-
Generate a navigation structure for mkdocs.yml.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- nav
- ResolvedNav
-
-
-
Resolved navigation data describing documentation groups
-and their associated Markdown files.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
A list of dictionaries representing the MkDocs navigation layout.
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
Each dictionary maps a navigation label to a page or a list of
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/nav/resolver/index.html b/doc-forge/lib/docforge/nav/resolver/index.html
deleted file mode 100644
index 160809f..0000000
--- a/doc-forge/lib/docforge/nav/resolver/index.html
+++ /dev/null
@@ -1,1700 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Resolver - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Resolver
-
-
-
-
-
-
-
-docforge.nav.resolver
-
-
-
-
-
-
-
Navigation resolution utilities.
-
This module resolves a NavSpec against the filesystem by expanding glob
-patterns and validating that referenced documentation files exist.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-ResolvedNav
-
-
-
-
ResolvedNav (
-home : str | None ,
-groups : dict [ str , list [ Path ]],
-docs_root : Path | None = None ,
-)
-
-
-
-
-
-
Resolved navigation structure.
-
A ResolvedNav represents navigation data after glob patterns have been
-expanded and paths validated against the filesystem.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- home
- str | None
-
-
-
-
Relative path to the documentation home page.
-
-
-
- groups
- dict[str, list[Path ]]
-
-
-
-
Mapping of navigation group titles to lists of resolved
-documentation file paths.
-
-
-
-
-
-
Initialize a ResolvedNav instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- home
- str | None
-
-
-
-
Relative path to the home page within the documentation root.
-
-
- required
-
-
-
- groups
- dict[str, list[Path ]]
-
-
-
-
Mapping of group titles to resolved documentation file paths.
-
-
- required
-
-
-
- docs_root
- Path | None
-
-
-
Root directory of the documentation source files.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-all_files
-
-
-
-
all_files () -> Iterable [ Path ]
-
-
-
-
-
Iterate over all files referenced by the navigation structure.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterable [Path ]
-
-
-
An iterable of Path objects representing documentation files.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- RuntimeError
-
-
-
-
If the home page is defined but the documentation
-root is not available for resolution.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-resolve_nav
-
-
-
-
resolve_nav ( spec : NavSpec , docs_root : Path ) -> ResolvedNav
-
-
-
-
-
Resolve a navigation specification against the filesystem.
-
The function expands glob patterns defined in a NavSpec and verifies
-that referenced documentation files exist within the documentation root.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- spec
- NavSpec
-
-
-
Navigation specification describing documentation layout.
-
-
- required
-
-
-
- docs_root
- Path
-
-
-
Root directory containing documentation Markdown files.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- ResolvedNav
-
-
-
A ResolvedNav instance containing validated navigation paths.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the documentation root does not exist or a
-navigation pattern does not match any files.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/nav/spec/index.html b/doc-forge/lib/docforge/nav/spec/index.html
deleted file mode 100644
index b32db3f..0000000
--- a/doc-forge/lib/docforge/nav/spec/index.html
+++ /dev/null
@@ -1,1815 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Spec - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Spec
-
-
-
-
-
-
-
-docforge.nav.spec
-
-
-
-
-
-
-
Navigation specification model.
-
This module defines the NavSpec class, which represents the navigation
-structure defined by the user in the doc-forge navigation specification
-(typically docforge.nav.yml).
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-NavSpec
-
-
-
-
NavSpec (
-home : str | None ,
-groups : dict [ str , list [ str ]],
-icon : dict [ str , str ] | None = None ,
-)
-
-
-
-
-
-
Parsed representation of a navigation specification.
-
A NavSpec describes the intended documentation navigation layout before
-it is resolved against the filesystem.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- home
- str | None
-
-
-
-
Relative path to the documentation home page (for example
-index.md).
-
-
-
- groups
- dict[str, list[str]]
-
-
-
-
Mapping of navigation group titles to lists of file patterns
-or glob expressions.
-
-
-
- icon
-
-
-
-
Optional mapping of theme icon entries (for example
-{"logo": "material/code-tags"}) injected into the MkDocs
-theme as theme.icon.
-
-
-
-
-
-
Initialize a NavSpec instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- home
- str | None
-
-
-
-
Relative path to the home document.
-
-
- required
-
-
-
- groups
- dict[str, list[str]]
-
-
-
-
Mapping of group names to lists of path patterns
-(glob expressions).
-
-
- required
-
-
-
- icon
- dict[str, str] | None
-
-
-
-
Optional mapping of theme icon entries applied to the
-generated MkDocs configuration.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-all_patterns
-
-
-
-
all_patterns () -> list [ str ]
-
-
-
-
-
Return all path patterns referenced by the specification.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- list[str]
-
-
-
-
A list containing the home document (if defined) and all
-
-
-
-
- list[str]
-
-
-
-
group pattern entries.
-
-
-
-
-
-
-
-
-
-
-
-
-
-load
-
-
-
- classmethod
-
-
-
load ( path : Path ) -> NavSpec
-
-
-
-
-
Load a navigation specification from a YAML file.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- Path
-
-
-
Filesystem path to the navigation specification file.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- NavSpec
-
-
-
A NavSpec instance representing the parsed configuration.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the specified file does not exist.
-
-
-
-
- ValueError
-
-
-
-
If the file contents are not a valid navigation
-specification.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-load_nav_spec
-
-
-
-
load_nav_spec ( path : Path ) -> NavSpec
-
-
-
-
-
Load a navigation specification file.
-
This helper function reads a YAML navigation file and constructs a
-corresponding NavSpec instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- Path
-
-
-
Path to the navigation specification file.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- NavSpec
-
-
-
A NavSpec instance representing the parsed specification.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- FileNotFoundError
-
-
-
-
If the specification file does not exist.
-
-
-
-
- ValueError
-
-
-
-
If the YAML structure is invalid.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/renderers/base/index.html b/doc-forge/lib/docforge/renderers/base/index.html
deleted file mode 100644
index 45aea6a..0000000
--- a/doc-forge/lib/docforge/renderers/base/index.html
+++ /dev/null
@@ -1,1614 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Base - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Base
-
-
-
-
-
-
-
-docforge.renderers.base
-
-
-
-
-
-
-
Summary
-
Renderer base interfaces and configuration models.
-
This module defines the base protocol and configuration container used by
-doc-forge renderers. Concrete renderer implementations should implement the
-DocRenderer protocol.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-DocRenderer
-
-
-
-
-
-
-
- Bases: Protocol
-
-
-
Protocol defining the interface for documentation renderers.
-
Implementations of this protocol are responsible for transforming a
-Project model into renderer-specific documentation sources.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-generate_sources
-
-
-
-
generate_sources ( project : Project , out_dir : Path ) -> None
-
-
-
-
-
Generate renderer-specific documentation sources.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Project model containing modules and documentation objects.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Directory where generated documentation sources should be written.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-RendererConfig
-
-
-
-
RendererConfig ( out_dir : Path , project : Project )
-
-
-
-
-
-
Configuration container for documentation renderers.
-
A RendererConfig instance groups together the project model and the
-output directory used during rendering.
-
-
-
Attributes:
-
-
-
- Name
- Type
- Description
-
-
-
-
- out_dir
- Path
-
-
-
Directory where generated documentation files will be written.
-
-
-
- project
- Project
-
-
-
Documentation project model to be rendered.
-
-
-
-
-
-
Initialize a RendererConfig instance.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- out_dir
- Path
-
-
-
Target directory where documentation files should be written.
-
-
- required
-
-
-
- project
- Project
-
-
-
Introspected project model to render.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/renderers/index.html b/doc-forge/lib/docforge/renderers/index.html
deleted file mode 100644
index b855575..0000000
--- a/doc-forge/lib/docforge/renderers/index.html
+++ /dev/null
@@ -1,1790 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Renderers - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Renderers
-
-
-
-
-
-
-
-docforge.renderers
-
-
-
-
-
-
-
Summary
-
Renderers layer for doc-forge.
-
The docforge.renderers package transforms the internal documentation
-models into files formatted for specific documentation systems.
-
-
Overview
-
Renderers consume the doc-forge project model and generate output suitable
-for documentation tools or machine interfaces.
-
Current implementations:
-
-MkDocsRenderer – Produces Markdown files compatible with MkDocs and
- the mkdocstrings plugin. It automatically handles package hierarchy
- and generates index.md files for packages.MCPRenderer – Emits structured JSON resources designed for consumption
- by Model Context Protocol (MCP) clients.
-
-
Extending
-
New renderers can be added by implementing the DocRenderer protocol
-defined in docforge.renderers.base.
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MCPRenderer
-
-
-
-
-
-
-
-
-
Renderer that generates MCP-compatible documentation resources.
-
This renderer converts doc-forge project models into structured JSON
-resources suitable for consumption by systems implementing the Model
-Context Protocol (MCP).
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-generate_sources
-
-
-
-
generate_sources ( project : Project , out_dir : Path ) -> None
-
-
-
-
-
Generate MCP documentation resources for a project.
-
The renderer serializes each module into a JSON resource and produces
-supporting metadata files such as nav.json and index.json.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Documentation project model to render.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Directory where MCP resources will be written.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-MkDocsRenderer
-
-
-
-
-
-
-
-
-
Renderer that produces Markdown documentation for MkDocs.
-
Generated pages use mkdocstrings directives to reference Python modules,
-allowing MkDocs to render API documentation dynamically.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-generate_readme
-
-
-
-
generate_readme (
-project : Project ,
-docs_dir : Path ,
-module_is_source : bool | None = None ,
-readme_dir : Path | None = None ,
-) -> None
-
-
-
-
-
Generate a README.md file from the root module docstring.
-
Behavior:
-
-If module_is_source is True, README.md is written to the project
- root directory.
-If False, README generation is currently not implemented.
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Project model containing documentation metadata.
-
-
- required
-
-
-
- docs_dir
- Path
-
-
-
Directory containing generated documentation sources.
-
-
- required
-
-
-
- module_is_source
- Optional[bool]
-
-
-
-
Whether the module is treated as the project source root.
-
-
- None
-
-
-
- readme_dir
- Optional[Path ]
-
-
-
-
Directory where the generated README.md should be written.
-Defaults to the parent of docs_dir.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-generate_sources
-
-
-
-
generate_sources (
-project : Project ,
-out_dir : Path ,
-module_is_source : bool | None = None ,
-) -> None
-
-
-
-
-
Generate Markdown documentation files for a project.
-
This method renders a documentation structure from the provided
-project model and writes the resulting Markdown files to the
-specified output directory.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Project model containing modules to document.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Directory where generated Markdown files will be written.
-
-
- required
-
-
-
- module_is_source
- bool
-
-
-
-
If True, treat the specified module as the documentation root
-rather than nesting it inside a folder.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/renderers/mcp_renderer/index.html b/doc-forge/lib/docforge/renderers/mcp_renderer/index.html
deleted file mode 100644
index 0365f55..0000000
--- a/doc-forge/lib/docforge/renderers/mcp_renderer/index.html
+++ /dev/null
@@ -1,1469 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Mcp Renderer - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Mcp Renderer
-
-
-
-
-
-
-
-docforge.renderers.mcp_renderer
-
-
-
-
-
-
-
Summary
-
MCP renderer implementation.
-
This module defines the MCPRenderer class, which generates documentation
-resources compatible with the Model Context Protocol (MCP).
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MCPRenderer
-
-
-
-
-
-
-
-
-
Renderer that generates MCP-compatible documentation resources.
-
This renderer converts doc-forge project models into structured JSON
-resources suitable for consumption by systems implementing the Model
-Context Protocol (MCP).
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-generate_sources
-
-
-
-
generate_sources ( project : Project , out_dir : Path ) -> None
-
-
-
-
-
Generate MCP documentation resources for a project.
-
The renderer serializes each module into a JSON resource and produces
-supporting metadata files such as nav.json and index.json.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Documentation project model to render.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Directory where MCP resources will be written.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/renderers/mkdocs_renderer/index.html b/doc-forge/lib/docforge/renderers/mkdocs_renderer/index.html
deleted file mode 100644
index 44546fd..0000000
--- a/doc-forge/lib/docforge/renderers/mkdocs_renderer/index.html
+++ /dev/null
@@ -1,1616 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Mkdocs Renderer - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Mkdocs Renderer
-
-
-
-
-
-
-
-docforge.renderers.mkdocs_renderer
-
-
-
-
-
-
-
Summary
-
MkDocs renderer implementation.
-
This module defines the MkDocsRenderer class, which generates Markdown
-documentation sources compatible with MkDocs Material and the mkdocstrings
-plugin.
-
The renderer ensures a consistent documentation structure by:
-
-Creating a root index.md if one does not exist
-Generating package index pages automatically
-Linking child modules within parent package pages
-Optionally generating README.md from the root package docstring
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MkDocsRenderer
-
-
-
-
-
-
-
-
-
Renderer that produces Markdown documentation for MkDocs.
-
Generated pages use mkdocstrings directives to reference Python modules,
-allowing MkDocs to render API documentation dynamically.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-generate_readme
-
-
-
-
generate_readme (
-project : Project ,
-docs_dir : Path ,
-module_is_source : bool | None = None ,
-readme_dir : Path | None = None ,
-) -> None
-
-
-
-
-
Generate a README.md file from the root module docstring.
-
Behavior:
-
-If module_is_source is True, README.md is written to the project
- root directory.
-If False, README generation is currently not implemented.
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Project model containing documentation metadata.
-
-
- required
-
-
-
- docs_dir
- Path
-
-
-
Directory containing generated documentation sources.
-
-
- required
-
-
-
- module_is_source
- Optional[bool]
-
-
-
-
Whether the module is treated as the project source root.
-
-
- None
-
-
-
- readme_dir
- Optional[Path ]
-
-
-
-
Directory where the generated README.md should be written.
-Defaults to the parent of docs_dir.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-generate_sources
-
-
-
-
generate_sources (
-project : Project ,
-out_dir : Path ,
-module_is_source : bool | None = None ,
-) -> None
-
-
-
-
-
Generate Markdown documentation files for a project.
-
This method renders a documentation structure from the provided
-project model and writes the resulting Markdown files to the
-specified output directory.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- project
- Project
-
-
-
Project model containing modules to document.
-
-
- required
-
-
-
- out_dir
- Path
-
-
-
Directory where generated Markdown files will be written.
-
-
- required
-
-
-
- module_is_source
- bool
-
-
-
-
If True, treat the specified module as the documentation root
-rather than nesting it inside a folder.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/docforge/servers/mcp_server/index.html b/doc-forge/lib/docforge/servers/mcp_server/index.html
deleted file mode 100644
index e50585c..0000000
--- a/doc-forge/lib/docforge/servers/mcp_server/index.html
+++ /dev/null
@@ -1,1508 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Mcp Server - docforge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Mcp Server
-
-
-
-
-
-
-
-docforge.servers.mcp_server
-
-
-
-
-
-
-
Summary
-
MCP server implementation.
-
This module defines the MCPServer class, which serves pre-generated
-documentation bundles through the Model Context Protocol (MCP).
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MCPServer
-
-
-
-
MCPServer ( mcp_root : Path , name : str )
-
-
-
-
-
-
MCP server for serving a pre-generated documentation bundle.
-
The server exposes documentation resources and diagnostic tools through
-MCP endpoints backed by JSON files generated by the MCP renderer.
-
-
Initialize the MCP server.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- mcp_root
- Path
-
-
-
Directory containing the generated MCP documentation bundle
-(for example index.json, nav.json, and modules/).
-
-
- required
-
-
-
- name
- str
-
-
-
-
Identifier used for the MCP server instance.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-run
-
-
-
-
run (
-transport : Literal [
-"stdio" , "sse" , "streamable-http"
-] = "streamable-http" ,
-) -> None
-
-
-
-
-
Start the MCP server.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- transport
- Literal ['stdio', 'sse', 'streamable-http']
-
-
-
Transport mechanism used by the MCP server. Supported options
-include stdio, sse, and streamable-http.
-
-
- 'streamable-http'
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/doc-forge/lib/index.html b/doc-forge/lib/index.html
index 1190ba7..d2ea2ce 100644
--- a/doc-forge/lib/index.html
+++ b/doc-forge/lib/index.html
@@ -339,6 +339,10 @@
+
+
+
+
@@ -423,6 +427,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1229,6 +1279,24 @@
+
+
+
+
+
+ Include a hand-written wiki in the MkDocs site:
+
+
+
+
+
+
+
+
+ Build wiki pages only (no module required):
+
+
+
@@ -1702,11 +1770,17 @@ outputs without executing user code.
Generate MkDocs site and MCP JSON documentation:
build --mcp --mkdocs --module my_package
Include a hand-written wiki in the MkDocs site:
+ build --wiki --mkdocs --module my_package
+
Build wiki pages only (no module required):
+ build --wiki --site-name my_package
+
Serve MkDocs locally:
- serve --mkdocs --module my_package
+ serve --mkdocs --module my_package
Serve MCP locally:
- serve --mcp --module my_package
+ serve --mcp --module my_package
Core concepts
@@ -1771,7 +1845,9 @@ MkDocs site or MCP JSON
Use Markdown headings at package and module level.
Use Google-style structured sections at class, function, and method level.
-Use type hints in signatures instead of duplicating types in prose.
+Use type hints in signatures.
+Use parenthesized types in prose entries (name (Type):) that match the
+ signature types. This keeps docstrings self-contained and machine-parseable.
Write summaries in imperative form.
Sections are separated by ---
@@ -1856,7 +1932,9 @@ MkDocs site or MCP JSON
engine.run()
```
Avoid fenced code blocks inside structured sections.
+ Avoid fenced code blocks inside argument descriptions and other prose lines.
+Inside Example: sections, fenced python code blocks are allowed and must be
+indented four spaces, matching the examples below.
Separator rules
Use horizontal separators only at docstring root level to separate sections:
@@ -2430,6 +2508,31 @@ Attributes:
code and transform the extracted information into Project, Module,
and DocObject instances used by doc-forge.
+
+Attributes:
+
+
+
+ Name
+ Type
+ Description
+
+
+
+
+ _loader
+ GriffeLoader
+
+
+
Internal Griffe loader with dedicated module and line collections.
+
+
+
+
+
Initialize the Griffe-backed loader.
Creates an internal Griffe loader instance with dedicated collections
for modules and source lines.
@@ -2516,6 +2619,52 @@ a doc-forge Module model.
+
+
Raises:
+
+
+
+ Type
+ Description
+
+
+
+
+
+ ImportError
+
+
+
+
If the module cannot be loaded by Griffe.
+
+
+
+
+ KeyError
+
+
+
+
If the loaded module is missing from the module collection.
+
+
+
+
+
+
+
+ Example
+ Load a single module:
+```python
+loader = GriffeLoader()
+module = loader.load_module("mypackage.submodule")
+```
+
Module model.
5 load_project (
module_paths : list [ str ],
project_name : str | None = None ,
-skip_import_errors : bool = None ,
+skip_import_errors : bool | None = None ,
) -> Project
@@ -2561,7 +2710,7 @@ object.
module_paths
- List[str]
+ list[str]
@@ -2575,7 +2724,7 @@ object.
project_name
- str
+ str | None
@@ -2590,7 +2739,7 @@ name of the first module.
skip_import_errors
- bool
+ bool | None
@@ -2831,13 +2980,16 @@ allowing MkDocs to render API documentation dynamically.
Generate a README.md file from the root module docstring.
-
Behavior:
-
-If module_is_source is True, README.md is written to the project
- root directory.
+
+
+
+ Notes
+
+If module_is_source is True, README.md is written to the
+ project root directory.
If False, README generation is currently not implemented.
-
+
Parameters:
@@ -2881,7 +3033,7 @@ allowing MkDocs to render API documentation dynamically.
module_is_source
- Optional[bool]
+ bool | None
@@ -2895,7 +3047,7 @@ allowing MkDocs to render API documentation dynamically.
readme_dir
- Optional[Path ]
+ Path | None
@@ -2983,7 +3135,7 @@ specified output directory.
module_is_source
- bool
+ bool | None
@@ -3067,7 +3219,7 @@ package and converts them into dotted module import paths.
project_root
- Path Path | None
@@ -3098,7 +3250,7 @@ current working directory is used.
-
List[str]:
+
list[str]:
A sorted list of unique dotted module import paths.
@@ -3139,9 +3291,7 @@ A sorted list of unique dotted module import paths.
-
+
diff --git a/doc-forge/lib/loaders/griffe_loader/index.html b/doc-forge/lib/loaders/griffe_loader/index.html
index 7462c28..213790e 100644
--- a/doc-forge/lib/loaders/griffe_loader/index.html
+++ b/doc-forge/lib/loaders/griffe_loader/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1470,6 +1520,16 @@
This module provides the GriffeLoader class and helper utilities used to
discover Python modules, introspect their structure, and convert the results
into doc-forge documentation models.
+
+ Notes
+
+All analysis is static; analyzed modules are never executed.
+Private members (names starting with _) are skipped during conversion.
+
+ Project, Module,
and DocObject instances used by doc-forge.
+
+Attributes:
+
+
+
+ Name
+ Type
+ Description
+
+
+
+
+ _loader
+ GriffeLoader
+
+
+
Internal Griffe loader with dedicated module and line collections.
+
+
+
+
+
Initialize the Griffe-backed loader.
Creates an internal Griffe loader instance with dedicated collections
for modules and source lines.
@@ -1588,6 +1673,52 @@ a doc-forge Module model.
+
+Raises:
+
+
+
+ Type
+ Description
+
+
+
+
+
+ ImportError
+
+
+
+
If the module cannot be loaded by Griffe.
+
+
+
+
+ KeyError
+
+
+
+
If the loaded module is missing from the module collection.
+
+
+
+
+
+
+
+ Example
+ Load a single module:
+```python
+loader = GriffeLoader()
+module = loader.load_module("mypackage.submodule")
+```
+
Module model.
5 load_project (
module_paths : list [ str ],
project_name : str | None = None ,
-skip_import_errors : bool = None ,
+skip_import_errors : bool | None = None ,
) -> Project
module_paths
- List[str]
+ list[str]
@@ -1647,7 +1778,7 @@ object.
project_name
- str
+ str | None
@@ -1662,7 +1793,7 @@ name of the first module.
skip_import_errors
- bool
+ bool | None
@@ -1801,7 +1932,7 @@ package and converts them into dotted module import paths.
project_root
- Path Path | None
@@ -1832,7 +1963,7 @@ current working directory is used.
-
List[str]:
+
list[str]:
A sorted list of unique dotted module import paths.
diff --git a/doc-forge/lib/loaders/index.html b/doc-forge/lib/loaders/index.html
index 88532fb..7980ab5 100644
--- a/doc-forge/lib/loaders/index.html
+++ b/doc-forge/lib/loaders/index.html
@@ -9,7 +9,7 @@
-
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1371,6 +1421,31 @@ initial filtering before the data is passed to the core documentation models.Project, Module,
and DocObject instances used by doc-forge.
+
+Attributes:
+
+
+
+ Name
+ Type
+ Description
+
+
+
+
+ _loader
+ GriffeLoader
+
+
+
Internal Griffe loader with dedicated module and line collections.
+
+
+
+
+
Initialize the Griffe-backed loader.
Creates an internal Griffe loader instance with dedicated collections
for modules and source lines.
@@ -1457,6 +1532,52 @@ a doc-forge Module model.
+
+
Raises:
+
+
+
+ Type
+ Description
+
+
+
+
+
+ ImportError
+
+
+
+
If the module cannot be loaded by Griffe.
+
+
+
+
+ KeyError
+
+
+
+
If the loaded module is missing from the module collection.
+
+
+
+
+
+
+
+ Example
+ Load a single module:
+```python
+loader = GriffeLoader()
+module = loader.load_module("mypackage.submodule")
+```
+
Module model.
5 load_project (
module_paths : list [ str ],
project_name : str | None = None ,
-skip_import_errors : bool = None ,
+skip_import_errors : bool | None = None ,
) -> Project
@@ -1502,7 +1623,7 @@ object.
module_paths
- List[str]
+ list[str]
@@ -1516,7 +1637,7 @@ object.
project_name
- str
+ str | None
@@ -1531,7 +1652,7 @@ name of the first module.
skip_import_errors
- bool
+ bool | None
@@ -1670,7 +1791,7 @@ package and converts them into dotted module import paths.
project_root
- Path Path | None
@@ -1701,7 +1822,7 @@ current working directory is used.
-
List[str]:
+
list[str]:
A sorted list of unique dotted module import paths.
diff --git a/doc-forge/lib/models/index.html b/doc-forge/lib/models/index.html
index 1bc957e..aaaa234 100644
--- a/doc-forge/lib/models/index.html
+++ b/doc-forge/lib/models/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1542,7 +1592,7 @@ of modules, classes, and other containers to be represented recursively.
signature
- Optional[str]
+ str | None
@@ -1553,7 +1603,7 @@ of modules, classes, and other containers to be represented recursively.
docstring
- Optional[str]
+ str | None
@@ -1564,7 +1614,7 @@ of modules, classes, and other containers to be represented recursively.
members
- Dict[str, DocObject ]
+ dict[str, DocObject ]
@@ -1634,7 +1684,7 @@ of modules, classes, and other containers to be represented recursively.
signature
- Optional[str]
+ str | None
@@ -1648,7 +1698,7 @@ of modules, classes, and other containers to be represented recursively.
docstring
- Optional[str]
+ str | None
@@ -1915,7 +1965,7 @@ introspection.
docstring
- Optional[str]
+ str | None
@@ -1926,7 +1976,7 @@ introspection.
members
- Dict[str, DocObject ]
+ dict[str, DocObject ]
@@ -1968,7 +2018,7 @@ introspection.
docstring
- Optional[str]
+ str | None
@@ -2232,7 +2282,7 @@ introspection. Each module is stored by its dotted import path.
modules
- Dict[str, Module ]
+ dict[str, Module ]
@@ -2275,6 +2325,19 @@ introspection. Each module is stored by its dotted import path.
+
+ Example
+ Create a project and register a module:
+```python
+project = Project("mypackage")
+project.add_module(module)
+```
+
+
diff --git a/doc-forge/lib/models/module/index.html b/doc-forge/lib/models/module/index.html
index 389ee6d..85fb8b9 100644
--- a/doc-forge/lib/models/module/index.html
+++ b/doc-forge/lib/models/module/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1441,6 +1491,15 @@
model. A
Module acts as a container for top-level documented objects
(classes, functions, variables, and other members) discovered during
introspection.
+
+
+
+
+ Notes
+
+Only public members are stored; private names are filtered by the loader.
+
+
@@ -1498,7 +1557,7 @@ introspection.
docstring
- Optional[str]
+ str | None
@@ -1509,7 +1568,7 @@ introspection.
members
- Dict[str, DocObject ]
+ dict[str, DocObject ]
@@ -1551,7 +1610,7 @@ introspection.
docstring
- Optional[str]
+ str | None
diff --git a/doc-forge/lib/models/object/index.html b/doc-forge/lib/models/object/index.html
index 157d0cd..baa4113 100644
--- a/doc-forge/lib/models/object/index.html
+++ b/doc-forge/lib/models/object/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1441,6 +1491,16 @@
the doc-forge documentation model. Each
DocObject represents a Python
entity such as a class, function, method, or attribute, and may contain nested
members that form a hierarchical documentation structure.
+
+
+
+
+ Notes
+
+DocObject instances form a tree mirroring the Python import hierarchy.Objects are renderer-agnostic and may be consumed by any renderer.
+
+
@@ -1532,7 +1592,7 @@ of modules, classes, and other containers to be represented recursively.
signature
- Optional[str]
+ str | None
@@ -1543,7 +1603,7 @@ of modules, classes, and other containers to be represented recursively.
docstring
- Optional[str]
+ str | None
@@ -1554,7 +1614,7 @@ of modules, classes, and other containers to be represented recursively.
members
- Dict[str, DocObject ]
+ dict[str, DocObject ]
@@ -1624,7 +1684,7 @@ of modules, classes, and other containers to be represented recursively.
signature
- Optional[str]
+ str | None
@@ -1638,7 +1698,7 @@ of modules, classes, and other containers to be represented recursively.
docstring
- Optional[str]
+ str | None
diff --git a/doc-forge/lib/models/project/index.html b/doc-forge/lib/models/project/index.html
index 0d67323..d327a82 100644
--- a/doc-forge/lib/models/project/index.html
+++ b/doc-forge/lib/models/project/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1458,6 +1508,16 @@
This module defines the Project class, the top-level container used by
doc-forge to represent a documented codebase. A Project aggregates multiple
modules and provides access to them through a unified interface.
+
+
+
+
+ Notes
+
+Modules are keyed by their dotted import path.
+Objects are renderer-agnostic; the same model feeds every renderer.
+
+
@@ -1514,7 +1574,7 @@ introspection. Each module is stored by its dotted import path.
modules
- Dict[str, Module ]
+ dict[str, Module ]
@@ -1557,6 +1617,19 @@ introspection. Each module is stored by its dotted import path.
+
+ Example
+ Create a project and register a module:
+```python
+project = Project("mypackage")
+project.add_module(module)
+```
+
+
diff --git a/doc-forge/lib/nav/index.html b/doc-forge/lib/nav/index.html
index 44cba4e..2bd6923 100644
--- a/doc-forge/lib/nav/index.html
+++ b/doc-forge/lib/nav/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1529,27 +1579,10 @@ and their associated Markdown files.
-
A list of dictionaries representing the MkDocs navigation layout.
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
Each dictionary maps a navigation label to a page or a list of
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
pages.
+
list[dict[str, Any]]:
+A list of dictionaries representing the MkDocs navigation layout.
+Each dictionary maps a navigation label to a page or a list of
+pages.
@@ -1750,17 +1783,9 @@ generated MkDocs configuration.
-
A list containing the home document (if defined) and all
-
-
-
-
- list[str]
-
-
-
-
group pattern entries.
+
list[str]:
+A list containing the home document (if defined) and all
+group pattern entries.
@@ -1824,13 +1849,13 @@ generated MkDocs configuration.
- Type
+Name Type
Description
-
+ NavSpec
NavSpec
@@ -2040,22 +2065,23 @@ documentation file paths.
Iterate over all files referenced by the navigation structure.
- Returns:
+ Yields:
- Type
+Name Type
Description
-
+ Path
Iterable [Path ]
-
An iterable of Path objects representing documentation files.
+
A documentation file referenced by the navigation, including
+the home page when defined.
@@ -2172,7 +2198,7 @@ the result directly usable in an MkDocs nav block with
-
List[Dict[str, Any]]:
+
list[dict[str, Any]]:
Navigation entries compatible with the MkDocs nav configuration.
The list is empty if the wiki contains no Markdown files.
NavSpec instance.
- Type
+Name Type
Description
-
+ NavSpec
NavSpec
@@ -2379,13 +2405,13 @@ that referenced documentation files exist within the documentation root.
- Type
+Name Type
Description
-
+ ResolvedNav
ResolvedNav
diff --git a/doc-forge/lib/nav/mkdocs/index.html b/doc-forge/lib/nav/mkdocs/index.html
index 3e2cfa4..ca0d2b5 100644
--- a/doc-forge/lib/nav/mkdocs/index.html
+++ b/doc-forge/lib/nav/mkdocs/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1385,6 +1435,16 @@
This module provides the MkDocsNavEmitter class, which converts a
ResolvedNav instance into the navigation structure required by the
MkDocs nav configuration.
+
+ Notes
+
+The emitted structure is a list of dictionaries, one per top-level nav
+ entry, matching the MkDocs nav YAML format.
+
+
-
A list of dictionaries representing the MkDocs navigation layout.
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
Each dictionary maps a navigation label to a page or a list of
-
-
-
-
- list[dict[str, Any ]]
-
-
-
-
pages.
+
list[dict[str, Any]]:
+A list of dictionaries representing the MkDocs navigation layout.
+Each dictionary maps a navigation label to a page or a list of
+pages.
diff --git a/doc-forge/lib/nav/resolver/index.html b/doc-forge/lib/nav/resolver/index.html
index a4d6ffc..3ed84ec 100644
--- a/doc-forge/lib/nav/resolver/index.html
+++ b/doc-forge/lib/nav/resolver/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1432,6 +1482,16 @@
Navigation resolution utilities.
This module resolves a NavSpec against the filesystem by expanding glob
patterns and validating that referenced documentation files exist.
+
+ Notes
+
+Glob resolution is recursive and returns paths in sorted order.
+Unmatched patterns raise FileNotFoundError to fail fast on typos.
+
+ Iterate over all files referenced by the navigation structure.
- Returns:
+ Yields:
- Type
+Name Type
Description
-
+ Path
Iterable [Path ]
-
An iterable of Path objects representing documentation files.
+
A documentation file referenced by the navigation, including
+the home page when defined.
@@ -1720,13 +1781,13 @@ that referenced documentation files exist within the documentation root.
- Type
+Name Type
Description
-
+ ResolvedNav
ResolvedNav
diff --git a/doc-forge/lib/nav/spec/index.html b/doc-forge/lib/nav/spec/index.html
index 057514d..b8c2a7c 100644
--- a/doc-forge/lib/nav/spec/index.html
+++ b/doc-forge/lib/nav/spec/index.html
@@ -343,6 +343,10 @@
+
+
+
+
@@ -427,6 +431,52 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Gsdfc Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mcp Guide
+
+
+
+
+
+
+
+
+
+
@@ -1451,6 +1501,17 @@
This module defines the NavSpec class, which represents the navigation
structure defined by the user in the doc-forge navigation specification
(typically docforge.nav.yml).
+
+ Notes
+
+The spec file supports an optional icon mapping for MkDocs theme
+ customization.
+All file references in groups are relative to the documentation root.
+
+
-
A list containing the home document (if defined) and all
-
-
-
-
- list[str]
-
-
-
-
group pattern entries.
+
list[str]:
+A list containing the home document (if defined) and all
+group pattern entries.
@@ -1719,13 +1772,13 @@ generated MkDocs configuration.
- Type
+Name Type
Description
-
+ NavSpec
NavSpec
@@ -1835,13 +1888,13 @@ corresponding NavSpec instance.
- Type
+Name Type
Description
-
+ NavSpec
NavSpec
diff --git a/doc-forge/lib/docforge/nav/wiki/index.html b/doc-forge/lib/nav/wiki/index.html
similarity index 87%
rename from doc-forge/lib/docforge/nav/wiki/index.html
rename to doc-forge/lib/nav/wiki/index.html
index 924f0ea..633ac2e 100644
--- a/doc-forge/lib/docforge/nav/wiki/index.html
+++ b/doc-forge/lib/nav/wiki/index.html
@@ -11,7 +11,7 @@
-
-
List[Dict[str, Any]]:
+
list[dict[str, Any]]:
Navigation entries compatible with the MkDocs nav configuration.
The list is empty if the wiki contains no Markdown files.