Let the documentation begin!

[mold]

Hej allihopa!

Jag tänkte bara ge er lite riktlinjer om hur ni bör dokumentera om ni vill att det ska se snyggt ut senare (när det genereras som html á la http://docs.python.org/2.7/).

Jag använder verktyget sphinx och här är en bra tutorial för hur docstringsen ska se ut: http://pythonhosted.org/an_example_pypi_project/sphinx.html

Ni behöver inte bry er om det som rör sphinx-verktygen, sånt kan jag ta på mig eftersom jag redan har sysslat lite med det.

Det är självklart viktigt att ni kommenterar alla metoder/klasser/pheta oneliners utförligt och läsligt, men ni behöver bara använda Sphinx-syntaxen för de metoder som ska användas av utomstående, det vill säga publika metoder. Privata metoder tänkte jag inte göra någon fin dokumentationssida av (vilket underlättar för alla inblandade) men de ska gärna dokumenteras ändå.

Frågor på det?

[mrunelov]

Kan tillägga, om någon missat det, att det finns exempel att utgå ifrån i bland annat tidaltrust.py på algo-branchen.