cli example changes
This commit is contained in:
@@ -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
|
your code from the rendering process, allowing you to generate documentation
|
||||||
for various platforms (starting with MkDocs) from a single internal models.
|
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
|
## Installation
|
||||||
|
|
||||||
Install using `pip` with the optional `mkdocs` dependencies for a complete setup:
|
Install using `pip` with the optional `mkdocs` dependencies for a complete setup:
|
||||||
@@ -16,10 +22,14 @@ pip install doc-forge
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
1. **Generate Markdown Sources**:
|
1. **Build Documentation**:
|
||||||
Introspect your package and create ready-to-use Markdown files:
|
Introspect your package and generate documentation in one step:
|
||||||
```bash
|
```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**:
|
2. **Define Navigation**:
|
||||||
@@ -33,14 +43,13 @@ pip install doc-forge
|
|||||||
- my_package/utils.md
|
- my_package/utils.md
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Generate MkDocs Configuration**:
|
3. **Preview**:
|
||||||
```bash
|
```bash
|
||||||
doc-forge mkdocs --site-name "My Awesome Docs"
|
# Serve MkDocs site
|
||||||
```
|
doc-forge serve --mkdocs
|
||||||
|
|
||||||
4. **Preview**:
|
# Serve MCP documentation
|
||||||
```bash
|
doc-forge serve --mcp
|
||||||
doc-forge serve
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|||||||
@@ -6,11 +6,9 @@ with doc-forge.
|
|||||||
|
|
||||||
## Available Commands
|
## Available Commands
|
||||||
|
|
||||||
|
- **build**: Build documentation (MkDocs site or MCP resources).
|
||||||
|
- **serve**: Serve documentation (MkDocs or MCP).
|
||||||
- **tree**: Visualize the introspected project structure.
|
- **tree**: Visualize the introspected project structure.
|
||||||
- **generate**: Create Markdown source files from Python code.
|
|
||||||
- **mkdocs**: Generate the primary `mkdocs.yml` configuration.
|
|
||||||
- **build**: Build the final documentation site.
|
|
||||||
- **serve**: Launch a local development server with live-reloading.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from .main import main
|
from .main import main
|
||||||
|
|||||||
Reference in New Issue
Block a user