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

Consider setting up readthedocs? #112

Open
zdexter opened this issue Dec 11, 2013 · 1 comment
Open

Consider setting up readthedocs? #112

zdexter opened this issue Dec 11, 2013 · 1 comment

Comments

@zdexter
Copy link
Collaborator

zdexter commented Dec 11, 2013

The current documentation is not precise enough on which properties go on which objects, etc. This has led to confusion and several PRs. It seems like the following would resolve this:

  1. Autogenerate API documentation from code
  2. Put these autogenerated docs along with a) examples and b) a quickstart on readthedocs.org

What do people think about this?

@juriejan
Copy link
Contributor

I don't think the docs are currently that bad, just a few ambiguities here and there, but there being ironed out by the community. That said, better docs are always, well, better. Let me know if I can help out.

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

No branches or pull requests

2 participants