Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
gone opened this issue Oct 29, 2011 · 3 comments
Open
Labels

Comments

@gone
Copy link
Collaborator

gone commented Oct 29, 2011

No description provided.

@j2labs
Copy link
Owner

j2labs commented Oct 31, 2011

Is sphinx your favorite way to do this?

@gone
Copy link
Collaborator Author

gone commented Oct 31, 2011

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
Copy link
Owner

j2labs commented Oct 31, 2011

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:
#34 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants