brubeck icon indicating copy to clipboard operation
brubeck copied to clipboard

Brubeck should autogenerate api docs from the docstrings of APIDocuments

Open gone opened this issue 13 years ago • 3 comments

gone avatar Oct 29 '11 20:10 gone

Is sphinx your favorite way to do this?

j2labs avatar Oct 31 '11 15:10 j2labs

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.

gone avatar Oct 31 '11 16:10 gone

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

On Oct 31, 2011, at 12:51 PM, gone [email protected] 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

j2labs avatar Oct 31 '11 16:10 j2labs