Lecture 5 — Automated Documentation (3h)

Lecture 5 — Automated Documentation (3h)#

Objectives

  • Use Doxygen for C/C++ and Sphinx (MyST) for Python/project docs

  • Generate API reference and write tutorial pages

  • Write docstrings/comments that tools can consume

Content summary

Doxygen comment syntax and Doxyfile basics. Sphinx quickstart and autodoc/autosummary with MyST. Hands-on: document a small C++ or Python example and build HTML docs.