๐ Polygon Area Calculator¶
Welcome to the official documentation for the Polygon Area Calculator โ
a clean, object-oriented Python module for working with rectangles and squares.
This project provides tools to compute:
- Area
- Perimeter
- Diagonal length
- ASCII-based shape drawings
- How many times one shape can fit inside another
- Class relationships (
Squareis a subclass ofRectangle)
All implemented using simple, well-structured Python classes.
๐ Features¶
- ๐ฆ Rectangle Class with full geometric operations
- ๐ฅ Square Class that inherits from Rectangle
- ๐ Accurate shape-packing calculations
- ๐ผ๏ธ ASCII art drawing support
- ๐งช Fully testable with
pytest - ๐ Cleanly documented using MkDocs Material
- ๐ฆ Installable Python package (
pip install .)
๐ Documentation Sections¶
Use the navigation on the left to explore:
- Usage โ How to use the Rectangle and Square classes
- API Reference โ Detailed method documentation
- Examples โ Practical demonstrations
๐งฉ Source Code¶
View the repository on GitHub:
๐ https://github.com/TheComputationalCore/Polygon-Area-Calculator
๐งช Running Tests¶
```bash pytest -q