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

API documentation #23

Open
faassen opened this issue Sep 22, 2014 · 2 comments
Open

API documentation #23

faassen opened this issue Sep 22, 2014 · 2 comments

Comments

@faassen
Copy link
Owner

faassen commented Sep 22, 2014

We need to generate API documentation in our sphinx documentation. For this we need to add the appropriate docstrings to the API too.

@faassen faassen added this to the 0.8 milestone Nov 19, 2014
@faassen
Copy link
Owner Author

faassen commented Nov 19, 2014

This is becoming more pressing; would be the best way to document the renderers and various other behaviors.

@faassen
Copy link
Owner Author

faassen commented Nov 19, 2014

It'd amount to creating an api.rst with the right directives and including it in the toc. Here's Morepath's example:

https://raw.githubusercontent.com/morepath/morepath/master/doc/api.rst

We'd need to do this for everything in __init__.py at least (also see #39).

@faassen faassen removed this from the 0.8 milestone Jan 14, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant