Skip to content

Latest commit

 

History

History

doc

Writing Documentation

Luigi uses Sphinx to generated documentation. Sphinx can be installed via pip install sphinx after which htmldocs can be generated with make html.

Sphinx uses ReStructuredText (RST) markup. There's a good quickstart describing the syntax. We also use the sphinx autodoc functionality to parse docstrings. For examples of cross-referencing modules/libraries/classes and for documentatingfunction/method arguments, see docs on the python domain.