[CentralOH] Sphinx

William McVey wam at cisco.com
Wed Nov 11 22:36:06 CET 2009

On Mon, 2009-11-09 at 14:24 -0500, Yung-Yu Chen wrote:
> For internal projects, I usually prefer to write API doc using epydoc
> rather than write book-style documentation with sphinx.  Full-fledged
> documentation is too heavy-weight to my projects, and readers are too
> limited.  API doc is more suitable to my need.

Sphinx totally allows you to build "api docs". With the
sphinx.ext.autodoc (an extension that ships with Sphinx) extension
enabled, it will pull documentation for your modules/class/functions
from docstrings. If you're working with Django, there is also the
djangodocs extension which provides easy ability to document template
tags, filters, settings variables, and a variety of other
django-specific project interfaces. This is for example how Django docs
(http://docs.djangoproject.com/en/dev/) are built (which has both a
combination of "prose style" docs as well as "api style" docs.)

  -- William

More information about the CentralOH mailing list