Python kommer sammen med pydoc. Du kan bruge pydoc til automatisk at generere dokumentation for dit modul eller din pakke. Til dette skal dit modul eller din pakke indeholde docstrings.

Du kan udføre pydoc direkte fra terminal. cd til den mappe, der indeholder det modul, som du vil automatisk generere en dokumentation for. Udfør derefter følgende kommando.

python -m pydoc -w modulename

I dette tilfælde er modulet modulnavn.py. Ovenstående kommando vil generere en .html-fil, der indeholder den automatisk genererede dokumentation.

For et større projekt foretrækker jeg at gemme al dokumentation for alle moduler i én mappe. Til dette opretter jeg først dokumentationen for hvert modul. Det gør jeg med ovenstående kommando.

Dernæst opretter jeg en tom mappe med kommandoen nedenfor

mkdir docs

I dette tilfælde kaldes den nye mappe “docs”.

Til sidst flytter jeg alle autogenererede .html-filer i docs – mappen.

mv *.html docs