Document your code

Objective

Explaining the requirement of documenting code bases in pythonic way. Showing different tips/tricks people use in real in various upstream projects.

Description

Writing documentation can lead to better code.

We will start from why and will go into details of how to document python codebases.

topics in the talk

• What to write -- What all details a developer should at least add
• reStructuredText -- a quick review of rst with examples
• Sphinx -- details of sphinx with example
• http://readthedocs.org -- How to use readthedocs for your project

Speaker bio

Kushal Das is a developer & contributor to various FOSS projects. He is using Python as his primary language for the last 6 years. He is upstream author for various python applications and libraries. He blogs at http://kushaldas.in

Links

• Details of rst with examples -- http://www.dgplug.org/irclogs/2012/rst-primer/

Comments

• ▲
  1
  ▼
  

  [-][+] Anand Chitipothu 943 days ago

  Hi Kushal,

  I think this talk should be part of "Software Development Tools" section. Can you please change it?

  [reply] [link]
  • ▲
    1
    ▼
    

    [-][+] kushaldas 943 days ago

    Never managed to find out how to do that. Any clue ?

    [reply] [link] [parent]
    • ▲
      1
      ▼
      

      [-][+] Anand Chitipothu 937 days ago (edited 937 days ago)

      Login and click "Edit this" link below talk title.

      Or here is the direct link:

      http://in.pycon.org/2012/funnel/pyconindia2012/8-document-your-code/edit

      [reply] [link] [parent]

Login with Twitter or Google to leave a comment →