Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

YouTube

Writing Documentation with Sphinx and reStructuredText

PyCon US via YouTube

Overview

Learn to create and build comprehensive documentation using Sphinx and reStructuredText in this 2-hour 28-minute tutorial from PyCon US. Explore the importance of quality documentation in Python and open source libraries, and discover why reStructuredText is the preferred markup language for official Python documentation and PEPs. Master various useful features of reStructuredText, overcoming common barriers to entry and gaining confidence in contributing to open source projects. By the end of this tutorial, you'll have the skills to create well-structured documentation projects using Sphinx, enhancing your ability to support and maintain Python open source libraries. Access the tutorial slides at https://sphinx-intro-tutorial.readthedocs.io/ for additional reference.

Syllabus

TUTORIAL / Mariatta / Writing Documentation with Sphinx and reStructuredText

Taught by

PyCon US

Reviews

Start your review of Writing Documentation with Sphinx and reStructuredText

Never Stop Learning.

Get personalized course recommendations, track subjects and courses with reminders, and more.

Someone learning on their laptop while sitting on the floor.