Document your code
summary
Argues that developers must write the first-pass docs and shows exactly how to produce searchable HTML, PDFs and slides from source using reStructuredText, Sphinx and rst tools (rst2html, rst2s5, rst2pdf), sets up a docs/ layout with sphinx-quickstart and Makefile, demonstrates running doctest from documentation so examples are executable and kept correct, and shows automatic publishing with readthedocs so builds update on each push.
AI-written summary · about
chapters (15)
- 0:00Start
- 13:33Packages you need
- 15:52Document title
- 18:04How to view the output ?
- 18:47Whitespace & paragraphs
- 19:31Section Titles
- 20:45Bullet Lists
- 22:26More on ordered lists
- 23:58Option Lists
- 24:10Literal Blocks
- 24:50Doctest blocks
- 25:36Grid Tables
- 25:50Hyperlinks
- 27:03Targeted Links
- 28:48Footnotes
related talks
02h 28mWriting Documentation with Sphinx and reStructuredText
40mDocumenting Python Code
02h 59mDocumenting your code from docstrings to automated builds
41mStop making fool of yourself about documentation
39mDevelopers Documentation: your hidden strength
45mDocs or it didn't happen!
35mThe practical implementation of Documentation as Code
47mDocumentation as code (explained to my dad)