updated doc strings
This commit is contained in:
@@ -1,14 +1,27 @@
|
||||
"""
|
||||
# CLI Layer
|
||||
Command line interface entry point for doc-forge.
|
||||
|
||||
The `docforge.cli` package provides the command-line interface for interacting
|
||||
with doc-forge.
|
||||
This module exposes the primary CLI entry function used by the
|
||||
``doc-forge`` command. The actual command implementation resides in
|
||||
``docforge.cli.main``, while this module provides a stable import path
|
||||
for external tools and the package entry point configuration.
|
||||
|
||||
## Available Commands
|
||||
The CLI is responsible for orchestrating documentation workflows such as
|
||||
generating renderer sources, building documentation sites, exporting
|
||||
machine-readable documentation bundles, and starting development or MCP
|
||||
servers.
|
||||
|
||||
- **build**: Build documentation (MkDocs site or MCP resources).
|
||||
- **serve**: Serve documentation (MkDocs or MCP).
|
||||
- **tree**: Visualize the introspected project structure.
|
||||
Typical usage
|
||||
-------------
|
||||
|
||||
The CLI is normally invoked through the installed command:
|
||||
|
||||
doc-forge <command> [options]
|
||||
|
||||
Programmatic invocation is also possible:
|
||||
|
||||
from docforge.cli import main
|
||||
main()
|
||||
"""
|
||||
|
||||
from .main import main
|
||||
|
||||
Reference in New Issue
Block a user