cli example changes

This commit is contained in:
2026-01-21 18:39:58 +05:30
parent c82868d5a7
commit bd294bea30
2 changed files with 20 additions and 13 deletions

View File

@@ -6,6 +6,12 @@ speed, flexibility, and beautiful output. It decouples the introspection of
your code from the rendering process, allowing you to generate documentation
for various platforms (starting with MkDocs) from a single internal models.
## Available Commands
- **build**: Build documentation (MkDocs site or MCP resources).
- **serve**: Serve documentation (MkDocs or MCP).
- **tree**: Visualize the introspected project structure.
## Installation
Install using `pip` with the optional `mkdocs` dependencies for a complete setup:
@@ -16,10 +22,14 @@ pip install doc-forge
## Quick Start
1. **Generate Markdown Sources**:
Introspect your package and create ready-to-use Markdown files:
1. **Build Documentation**:
Introspect your package and generate documentation in one step:
```bash
doc-forge generate --module my_package --docs-dir docs
# Build MkDocs site
doc-forge build --mkdocs --module my_package --site-name "My Docs"
# Build MCP resources
doc-forge build --mcp --module my_package
```
2. **Define Navigation**:
@@ -33,14 +43,13 @@ pip install doc-forge
- my_package/utils.md
```
3. **Generate MkDocs Configuration**:
3. **Preview**:
```bash
doc-forge mkdocs --site-name "My Awesome Docs"
```
# Serve MkDocs site
doc-forge serve --mkdocs
4. **Preview**:
```bash
doc-forge serve
# Serve MCP documentation
doc-forge serve --mcp
```
## Project Structure