Creating the Sample Python Package
00:00 Create the Sample Python Package. To document a Python project, you first need a Python project. In this course, you’ll use a toy implementation of a calculator package that returns floating-point numbers.
00:15 If you already have a Python project for which you want to generate your documentation, then feel free to use that project instead. If that’s the case, you can skip this part and jump directly to the next section of the course.
As seen on-screen, you’ll keep the second file,
__init__.py, empty for now. For now, it’s here to help declare calculator as a package. Later on, you’ll add package-level docstrings in the file, which you’ll also pull into your auto-generated documentation.
Become a Member to join the conversation.