Documenting Python Projects With Sphinx and Read The Docs

Mahdi Yusuf 6 Lessons 17m
best-practices intermediate

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.

Note: This course uses Python 2.7 in its coding examples and requires a Linux or macOS terminal environment for running Sphinx commands.

Resources

Get Started

Document Python Projects With Sphinx & Read The Docs

6 Lessons 17m

1. Python Project Documentation Overview 00:33

2. Setting Up a Sphinx Example Project and Scaffolding 04:28

3. Updating Your Sphinx Documentation 03:05

4. Previewing ReStructuredText (.rst) Files 03:17

5. Configuring Sphinx Subheadings With :maxdepth: 01:51

6. Hosting Your Documentation on Read The Docs 04:01

Get Started

About 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:

Sadie

Tappan

Vuyisile

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