Epydoc

Epydoc

Epydoc generates html documentation for our project. To generate documentation, just run ./manage.py makedocs. This creates html documentation inside the doc directory. To view the documentation, just open doc/index.html in a web browser. To add or remove a directory to the list of searched directories, edit folders_to_include in apps/utils/management/commands/makedocs.py

Documenting Code

To document code, just add a docstring. Epydoc includes formatting tags to indicate things like parameters and return values, a full list can be found here. At minimum, every function should list the return value as @return and include a short description of what it does.