Package and module documentation
Package and module level documentation helps your users navigate your package.
In this exercise, you will write documentation for the impyrial package. Pay attention to this documentation, you're going to be working on this package throughout this course, and it's worth knowing what its different parts do.
Note: You can open/close the folder and files overview by clicking on the icon on the left side of the editor highlighted in red.
This exercise is part of the course
Developing Python Packages
Exercise instructions
- Add the following package level documentation to
impyrial:
impyrial
========
A package for converting between imperial
measurements of length and weight.
- Add the following subpackage level documentation to
impyrial.length:
impyrial.length
===============
Length conversion between imperial units.
- Add the following module documentation to
impyrial.length.core:
Conversions between inches and
larger imperial length units
Hands-on interactive exercise
Turn theory into action with one of our interactive exercises
Start Exercise