search

j2labs / brubeck

Asynchronous web and messaging
http://brubeck.io
510 stars 66 forks source link

Brubeck should autogenerate api docs from the docstrings of APIDocuments #34

Open gone opened 12 years ago

j2labs commented 12 years ago

Is sphinx your favorite way to do this?

gone commented 12 years ago

yeah spinx would be great - I don't know enough about the options to know if there's anything else worth using. I know piston handles this via django templates, and adds some methods for documenting the code along with the api-ifying part.

Do we want to stay agnostic? I'd be ok with just using sphinx.

j2labs commented 12 years ago

Sphinx is good with me. It's also what readthedocs.org uses.

On Oct 31, 2011, at 12:51 PM, gone reply@reply.github.com wrote:

yeah spinx would be great - I don't know enough about the options to know if there's anything else worth using. I know piston handles this via django templates, and adds some methods for documenting the code along with the api-ifying part.

Do we want to stay agnostic? I'd be ok with just using sphinx.

Reply to this email directly or view it on GitHub: https://github.com/j2labs/brubeck/issues/34#issuecomment-2579567