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

Flesh out docs, sphinx it up, deploy to rtfd.org #1

Open
estebistec opened this issue Aug 15, 2011 · 0 comments
Open

Flesh out docs, sphinx it up, deploy to rtfd.org #1

estebistec opened this issue Aug 15, 2011 · 0 comments

Comments

@estebistec
Copy link
Member

The docs could be more clear - e.g., the types returned from the client don't say what fields are guaranteed and which may not be there.

All that exists now is a short readme and lots of pydoc embedded in the sources - there should probably be a cohesive sphinx project tying all of it together and making it easy to find what you need.

Once that's done, may as well deploy this to readthedocs.

@ghost ghost assigned estebistec Aug 15, 2011
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

1 participant