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

YouTube

Building Docs like Code - Continuous Integration for Documentation

PyCon US via YouTube

Start learning Write review
DataCamp Ad

AI Engineer - Learn how to integrate AI into software applications

Learn More → Corporate Finance Institute Ad

Finance Certifications Goldman Sachs and Amazon Teams Trust

Learn More →

Overview

Google, IBM & Meta Certificates – 40% Off
One Coursera Plus subscription covers most Professional Certificates on Coursera.
Unlock All Certificates
This talk presents a workflow for maintaining documentation alongside code using tools such as MkDocs and Sphinx. It covers integrating documentation into code reviews and CI pipelines, including checks for examples and broken links.

Syllabus

Intro
A Common Approach to Documentation
Issues with This Approach
Why Do Developers Dislike Writing Documentation?
The Real Issue
What Do We Mean When We Say "Treat Docs Like Code"?
What Do We Gain From This?
Case Study
How Does This Change the Workflow?
What is Continuous Integration and Continuous Deployment (CI/CD)?
What Does This Mean for Docs?
Types of Documentation
Documentation Tools - Mkdocs
Documentation Tools - Sphinx
Sphinx - Documentation Testing
Documentation Tools - ronn
My Solution
Final Thoughts
But Wait! There's More

Taught by

PyCon US

Reviews

Start your review of Building Docs like Code - Continuous Integration for Documentation

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.