Introduction to Sphinx & Read the Docs
summary
Covers concrete claims and a working stack: reStructuredText (semantic markup) + Sphinx (directives, autodoc pulls docstrings, doctest, table-of-contents tree) and Read the Docs (GitHub webhooks that auto-build, hosts versions, PDFs/epubs, custom theme, ElasticSearch). Demo builds locally and deploys during the session; project began as a 48‑hour Django Dash prototype and now serves 15 million pageviews/month, so tooling and hosting are proven and production‑scale.
AI-written summary · about
chapters (4)
- 0:00Why write documentation
- 4:54Understanding RST
- 14:33Introduction to Sphinx
- 21:04Read the Docs platform
related talks
45mIntroduction to Sphinx & Read the Docs
33mWrite the Docs!
27mPractical Sphinx
02h 28mWriting Documentation with Sphinx and reStructuredText
42mEngineering Documentation
23mTreating Documentation like Code: a Practical Account
19mWhere Docs, Cloud-hosted Interactive Tutorials and CI Testing Intersect
36mBuilding Docs like Code: Continuous Integration for Documentation