T04-Python-documentation.md

Python Documentation

Prep

1. Complete the RealPython Documenting Python Code Learning Path
2. Skim the numpydoc docstring guide.
3. Read Getting Started with Sphinx.

Seminar Goals

Discuss methods of documentation, the importance of documentation, and how we will apply it to the turboPy project. Review some of the documentation that you created for your code submissions.

Homework

1. Go through some of the work you've done so far and add numpydoc formatted docstrings.

Notes