search

futuregrid / cloud-metrics

Project to create usage statistics from IaaS such as OpenStack, Eucalyptus, and Nimbus
2 stars 3 forks source link

Docstring in source codes for auto modules in Sphinx #42

Open lee212 opened 12 years ago

lee212 commented 12 years ago

The comments and texts written in reStructuredText in a source code can be imported using the autodoc extension of sphinx.

Our goal of this issue is about to write a short description for a function and a module which have been implemented so that documentation would be auto-generated and would be published on the web.

Reference: [1] autodoc: http://sphinx.pocoo.org/ext/autodoc.html

lee212 commented 12 years ago

Most modules have Python documentation strings (or docstrings) except newly added modules.

Every module is required to write a simple description.