Skip to content

๐Ÿ“ 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 (Square is a subclass of Rectangle)

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