Python Best Practices Artwork

Documenting Python Projects With Sphinx and Read The Docs

In this video series we’ll cover creating Python documentation from scratch using Sphinx, as well as getting your code repository hooked up to Read The Docs, to automatically build and publish your code documentation.

Resources

About Mahdi Yusuf

Mahdi Yusuf

Mahdi is the CTO of Gyroscope, the co-founder of the PyCoder’s Weekly, and a longtime Pythoneer.

» More about Mahdi

Each tutorial at Real Python is created by a team of developers so that it meets our high quality standards. The team members who worked on this tutorial are:

Participant Comments

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/

« Browse All Courses