Automating API Documentation
summary
Automated documentation pipeline uses Sphinx + rst + Python to pull schema files and example artifacts from the QA automation console, producing HTML and PDF outputs; pipeline handles 13,000+ endpoints and reduces full-generation time from about seven hours to roughly two hours (PDF export 30–45 minutes). Setup needs Python, optional LaTeX for PDF, ~2 GB RAM, and three scripts; release cadence includes ~40–50 features per minor release and ~150 per major release, with a 12-person docs team.
AI-written summary · about
chapters (12)
- 0:00Introduction
- 1:00Presentation
- 1:20Agenda
- 1:55Manual vs Automated API Documentation
- 5:43Why Automated API Documentation
- 8:08Automated Documentation Setup
- 8:48Source Folder
- 10:00Example Folder
- 11:00Generate PDF
- 11:36Output
- 11:50Instant Schema
- 13:15Metacat Flare
related talks
33mWrite the Docs!
02h 28mWriting Documentation with Sphinx and reStructuredText
38mZen And The Art Of Automanually Creating API Documentation - An Inquiry Into Process
46mAutomate Documentation with Sphinx & GitHub Actions
27mPractical Sphinx
45mIntroduction to Sphinx & Read the Docs
40mThe Rocky Road to DocOps
40mDocumenting Python Code