template-python / docs /README.md
npv2k1's picture
update
eee346e
|
raw
history blame
1.03 kB
# Project Documentation
Welcome to the documentation for the Python Template Project.
## Table of Contents
1. [Getting Started](getting-started.md)
2. [Project Structure](project-structure.md)
3. [Development Guide](development.md)
4. [API Documentation](api.md)
5. [Testing Guide](testing.md)
6. [Deployment Guide](deployment.md)
## Overview
This template provides a foundation for Python projects with:
- Modern Python project structure
- Development tooling configuration
- Testing framework setup
- Docker support
- Documentation templates
- CI/CD examples
## Quick Links
- [Installation Guide](getting-started.md#installation)
- [Development Setup](development.md#setup)
- [Running Tests](testing.md#running-tests)
- [Docker Guide](deployment.md#docker)
- [API Reference](api.md#endpoints)
## Contributing
See our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to this project.
## License
This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details.