Documentation with Sphinx#

Topics of interest#

About rST itself:

  • cheat sheet about rST (tricky parts, common errors, tooling to format and lint it).

  • docutils internals (parser, doctree, …)

About Sphinx:

  • sphinx rST (directives, custom nodes, …)

  • sphinx configuration (conf.py)

  • sphinx extension and themes

About documentation best practices:

  • how to maintain a documentation according to different purposes and audiences.