Join us and get access to hundreds of tutorials and a community of expert Pythonistas.

Unlock This Lesson

This lesson is for members only. Join us and get access to hundreds of tutorials and a community of expert Pythonistas.

Unlock This Lesson

Hint: You can adjust the default video playback speed in your account settings.
Hint: You can set the default subtitles language 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 see our video player troubleshooting guide to resolve the issue.

Documenting Your Python Projects (Part 2)

In this lesson, you’ll see what should be included in the documentation of your project. Here are the tools, references, and projects that are mentioned:

Download

Sample Code (.zip)

1.6 KB

Download

Course Slides (PDF)

236.2 KB

Thomas on Feb. 10, 2020

Thanks for this concise tutorial on documentation. Especially Epytext makes my life as a Java developer a lot easier writing Python documentation. I find this topic dead boring, but this tutorial made it a lot easier to get started:)

Andrew Stephen RP Team on Feb. 10, 2020

Hi Thomas, Glad this helped you out with getting started! Hopefully moving forward you become so proficient at your documentation that it no longer takes long enough to bore you ;)

Pierre on June 7, 2020

Thanks very much for the tutorial, Andrew. Been fumbling through the topic as an amateur coder using the Sphinx and ReadTheDocs docs. Nice to have your synthesis confirm I’m not totally out to lunch.

Become a Member to join the conversation.