Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 999 Bytes

File metadata and controls

44 lines (31 loc) · 999 Bytes

Prerequisites

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

Installation

pip install .

To install from source:

git clone <repository-url>
cd code2docs
pip install -e .

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

```python
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