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

YouTube

Documenting Your Code From Docstrings to Automated Builds

PyCon US via YouTube

Start learning Write review
Corporate Finance Institute Ad

Learn Excel and Financial Modeling the Way Finance Teams Actually Use Them

Learn More → Noble Desktop Ad

Live Online Classes in Design, Coding & AI — Small Classes, Free Retakes

Learn More →

Overview

Google, IBM & Meta Certificates – 40% Off
One Coursera Plus subscription covers most Professional Certificates on Coursera.
Unlock All Certificates
This course develops a workflow for documenting Python code, from comments, docstrings, and type annotations to prose and API documentation. It uses JupyterBook, Jupyter Notebooks, Markdown, and Sphinx, then automates building and publishing the documentation.

Syllabus

Intro
Jacob Deppen
Why does documentation matter
Values of documentation
Who am I
Who am I not
Why this tutorial
The workflow
Sphinx
Pros to Sphinx
Sticky Notes
Clone to local machine
Setup environment
Explore code
Documentation level 1
Type annotations
Pros Cons
Practice module
Return type
Invalid type

Taught by

PyCon US

Reviews

Start your review of Documenting Your Code From Docstrings to Automated Builds

Start learning

Never Stop Learning.

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

Sign up for free
Someone learning on their laptop while sitting on the floor.