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

Mahdi Yusuf
Documenting Python Projects With Sphinx and Read The Docs - Archived Mahdi Yusuf 00:33

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

00:00 Hi. My name is Mahdi Yusuf. We’ll be discussing Sphinx, the Python documentation generator, and Read the Docs. If you’ve ever read documentation for any particular Python project, you’ve likely used one or both of these tools.

00:12 We’ll be talking about how to set up your documentation for your particular project, how to get started, how to structure your project, a little bit of tips on how to generate HTML and LaTeX PDF versions of your documentation, as well as getting your documentation built as you push code.

00:29 So, let’s get started.

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.