getting-started.md

Getting Started with code2docs

Prerequisites

• Python >=3.9
• pip (or your preferred package manager)

Installation

pip install .

To install from source:

git clone https://github.com/wronai/code2docs
cd code2docs
pip install -e .

Quick Start

Command Line

# Generate full documentation for your project
code2docs ./path/to/your/project

# Preview what would be generated (no file writes)
code2docs ./path/to/your/project --dry-run

# Only regenerate README
code2docs ./path/to/your/project --readme-only

Python API

from analyzers.project_scanner import analyze_and_document

# Convenience function: analyze a project in one call.
result = analyze_and_document("project_path", config=...)

What's Next

• 📖 API Reference — Full function and class documentation
• 🏗️ Architecture — System design and module relationships
• 📊 Coverage Report — Docstring coverage analysis
• 🔗 Dependency Graph — Module dependency visualization