Hint: You can adjust the default video playback speed in your account settings.
Hint: You can set your subtitle preferences in your account settings.
Sorry! Looks like there’s an issue with video playback 🙁 This might be due to a temporary outage or because of a configuration issue with your browser. Please refer to our video player troubleshooting guide for assistance.

Python Project Documentation Overview

This lesson is an overview of what you’ll learn in this course. You’ll learn how to use Sphinx and Read The Docs, two important documentation tools. In future lessons, you will also see how to:

  • Setup and structure documentation for your project
  • Generate HTML, LaTeX and PDF versions of your code
  • Build documentation as you push code

Tim Pozza on March 30, 2019

I found this course useful as a refresher, and a good complement to this: realpython.com/documenting-python-code/

Become a Member to join the conversation.