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

Add documentation #23

Merged
merged 18 commits into from Jul 28, 2013
Merged

Add documentation #23

merged 18 commits into from Jul 28, 2013

Conversation

treyhunner
Copy link
Collaborator

Goal of this PR:

  • Add quickstart documentation
  • Improve docstrings
  • Note features available in this package
  • Document basic usage for each feature
  • Host documentation on readthedocs.org
  • Add CONTRIBUTING.rst file and Makefile, noting how to contribute to the project

@zen4ever
Copy link
Owner

Yes, that's a great idea.

@treyhunner
Copy link
Collaborator Author

I've just turned this into a pull request.

You might want to setup a readthedocs.org account at some point and point it to the docs branch for now.

I've compiled a checklist of goals in the pull request description. Feel free to modify it.

treyhunner added a commit that referenced this pull request Jul 28, 2013
@treyhunner treyhunner merged commit 0342e79 into master Jul 28, 2013
@treyhunner treyhunner deleted the docs branch July 28, 2013 04:17
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

Successfully merging this pull request may close these issues.

None yet

2 participants