Project 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
5. Deployment Pipeline

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

Project Overview

Do math with your own functions.

Modules exported by this package:

• proj: Provide several sample math calculations.