index.md

Calculator Docs

This site contains the project documentation for the calculator project that is a toy module used in the Real Python tutorial Build Your Python Project Documentation With MkDocs. Its aim is to give you a framework to build your project documentation using Python, MkDocs, mkdocstrings, and the Material for MkDocs theme.

Table Of Contents

The documentation follows the best practice for project documentation as described by Daniele Procida in the Diátaxis documentation framework and consists of four separate parts:

1. Tutorials
2. How-To Guides
3. Reference
4. Explanation

Quickly find what you're looking for depending on your use case by looking at the different pages.

Project Overview

::: calculator.init

Acknowledgements

I want to thank my house plants for providing me with a negligible amount of oxygen each day. Also, I want to thank the sun for providing more than half of their nourishment free of charge.