search

openplans / openblock

OpenBlock is a web application and RESTful service that allows users to browse and search their local area for "hyper-local news
61 stars 26 forks source link

Python API docs #163

Closed slinkp closed 11 years ago

slinkp commented 11 years ago

It would be nice to have (initially very incomplete, due to lack of docstrings) Sphinx API documentation for ebpub, ebdata, and obadmin.

There are some tools to help generate stub rst files, see http://sphinx.pocoo.org/ext/autosummary.html

The existing packages/ documentation would be mostly moved into docstrings, with maybe some overview bits left behind in the stub rst files.

slinkp commented 11 years ago

Milestone Beta Release 1 deleted

slinkp commented 11 years ago

Dupe of #159

slinkp commented 11 years ago

Ticket imported from Trac: http://developer.openblockproject.org/ticket/170 Reported by: slinkp