Explore a proven method for integrating documentation into the development workflow in this PyCon US talk. Learn how to treat documentation as code, leveraging tools like MkDocs and Sphinx alongside Continuous Integration practices. Discover how this approach can lead to more up-to-date and maintainable documentation, addressing common challenges faced by development teams. Gain insights into implementing a documentation pipeline that fits seamlessly into existing workflows, making documentation updates a natural part of the development process. Walk away with practical strategies for improving documentation practices, including code reviews, versioning, and automated testing for code examples and broken links. Understand the benefits of this approach through a real-world case study and learn how to apply these techniques in your own projects to enhance documentation quality and developer engagement.
Building Docs like Code - Continuous Integration for Documentation
Overview
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
