Metadata-Version: 2.4
Name: socratic-docs
Version: 0.2.0
Summary: Automated documentation generation for projects
Home-page: https://github.com/Nireus79/Socratic-docs
Author: Socratic Team
Author-email: Socratic Team <team@socratic.dev>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Nireus79/Socratic-docs
Project-URL: Repository, https://github.com/Nireus79/Socratic-docs
Project-URL: Documentation, https://github.com/Nireus79/Socratic-docs#readme
Project-URL: Issues, https://github.com/Nireus79/Socratic-docs/issues
Keywords: documentation,generation,automated,sphinx,markdown,api-docs
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# Socratic Docs

Automated documentation generation for projects.

## Features

- **DocumentationGenerator**: Auto-generate project documentation
  - Comprehensive README.md
  - API reference documentation
  - Architecture documentation
  - Setup/installation guides

## Installation

```bash
pip install socratic-docs
```

## Usage

```python
from socratic_docs import DocumentationGenerator

generator = DocumentationGenerator()

project = {
    "name": "My Project",
    "description": "A great project",
    "features": ["Feature 1", "Feature 2"],
    "repo_url": "https://github.com/user/project"
}

code_structure = {
    "classes": ["ClassA", "ClassB"],
    "functions": ["func1", "func2"],
    "modules": ["module1", "module2"]
}

docs = generator.generate_all(project, code_structure)
# Returns dict with README.md, API.md, ARCHITECTURE.md, SETUP.md
```

## Documentation

- **[Documentation Generation Guide](docs/DOCUMENTATION_GENERATION.md)** - Complete guide to automatic documentation generation, including README generation, API documentation, architecture documentation, and setup guides

## License

MIT
