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

Create documentation (tutorial) and reference (methods and docstrings) #15

Open
fccoelho opened this issue Feb 22, 2013 · 2 comments
Open
Milestone

Comments

@fccoelho
Copy link
Member

We need a sphinx documentation for the API ASAP!

I am marking this as a bug because an API without docs is pretty much useless.

@turicas
Copy link
Contributor

turicas commented Feb 22, 2013

There are not so many methods in the only one class available (PyPLN), all of them have docstrings and the general usage of them are covered in the tutorial.
I think we should not waste time now in this library until we have a REST API on pypln.web, so we can work in a more solid code base (the current code is just a temporary thing). Because of this, I removed the label "bug".

@fccoelho
Copy link
Member Author

It shouldn't require much effort just the setup of a sphinx project for the API, it would then extract the docstrings and generate a minimal documentation. But I'll leave the decision to you since I am not the one doing it.

@turicas turicas added this to the 0.3.0 milestone Feb 12, 2014
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