YoVDO

Writing Documentation with Sphinx and reStructuredText

Offered By: PyCon US via YouTube

Tags

PyCon US Courses Python Courses Documentation Writing Courses Sphinx Courses

Course Description

Overview

Save Big on Coursera Plus. 7,000+ courses at $160 off. Limited Time Only!
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

Related Courses

Python Best Practices for Code Quality
Pluralsight
Software Engineering for Research - Dr. James Hetherington, Turing
Alan Turing Institute via YouTube
Python 3 Best Practices
Pluralsight
Reno - A New Way to Manage Release Notes
EuroPython Conference via YouTube
What is the Best Full Text Search Engine for Python?
EuroPython Conference via YouTube