Documenting Code

• Python doc strings allow classes and functions to provide documentation to end users. Use them!
• For large projects, Sphinx is the most commonly used documentation system.
• For documenting modules, the NumPy/SciPy documentation conventions is widely followed.
• See our local ADMIT Documentation Style Guide for more links and tips.
• These slides themselves were written in reStructuredText and collected into a Sphinx project.