Document your code

Who am I?

... continued

• Fedora Ambassador
• Upstream author various Python applications
• Package maintainer in Fedora
• Photographer

Remember

Everyone reads documentation

Why?

• Documentation == Communication
• Documentation == Good code

What you will see?

Who should do it?

• Developers
• Project contributors

Good examples in community?

• Qt
• KDE
• Django

What to document?

• Tutorials
• If you are a library developer then all your publicly available API
• Contributor guide
• User documentation
• HOWTOs

How?

• reStructuredText
• Sphinx project

reStructuredText tutorial

http://www.dgplug.org/irclogs/2012/rst-primer/

Using Sphinx

• pypress revision 1
• pypress revision 2
• pypress revision 3

Host it online

http://readthedocs.org

Publican

You can use it for user guides. url

Questions

?

Thank you

Find all the examples at http://dgplug.org/irclogs/2012/document