Metadata-Version: 2.4
Name: thedoc
Version: 0.1.0
Summary: A omni-documentation generation tool that works with any programming language, I hope
Author-email: karim amin <kareemamin2005@gmail.com>
License-Expression: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Requires-Dist: click>=8.0.0
Requires-Dist: gitpython>=3.1.0
Requires-Dist: mkdocs-material>=9.0.0
Requires-Dist: mkdocs>=1.5.0
Requires-Dist: pyyaml>=6.0.0
Provides-Extra: dev
Requires-Dist: black>=23.0.0; extra == 'dev'
Requires-Dist: flake8>=6.0.0; extra == 'dev'
Requires-Dist: isort>=5.0.0; extra == 'dev'
Requires-Dist: mypy>=1.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# TheDoc

A powerful documentation generation tool that works with any programming language. TheDoc automatically generates comprehensive documentation and release notes based on conventional commits, with seamless MkDocs integration for beautiful web documentation.

## Features

- Language-agnostic code analysis
- Automatic documentation generation
- Release notes generation from conventional commits
- MkDocs integration for web documentation
- Support for multiple programming languages
- Customizable documentation templates

## Installation

```bash
pip install thedoc
```

## Quick Start

1. Initialize TheDoc in your project:
```bash
thedoc init
```

2. Generate documentation:
```bash
thedoc generate
```

3. Generate release notes:
```bash
thedoc release-notes
```

4. Build MkDocs site:
```bash
thedoc build
```

## Development

### Setup Development Environment

```bash
# Clone the repository
git clone https://github.com/karimomino/thedoc.git
cd thedoc

# Create and activate virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"
```

### Running Tests

```bash
pytest
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the LICENSE file for details. 