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

Bring docs up to spec #14

Open
10 tasks
ssokolow opened this issue Apr 10, 2017 · 0 comments
Open
10 tasks

Bring docs up to spec #14

ssokolow opened this issue Apr 10, 2017 · 0 comments

Comments

@ssokolow
Copy link
Owner

ssokolow commented Apr 10, 2017

Currently, the only documentation is the README.rst file, the docstrings, and some code comments.

I'd like to make the following improvements to bring the docs up to the standard I aspire to:

  • Add a CONTRIBUTING.rst to the repo
  • Audit the code and add more comments anywhere that the intent may still be vague
  • Improve the PyPI description to better "sell the product"
    • Include the badges from the README.
    • Provide a longer, richer description on PyPI.
  • Write a manual
    • Write a basic introduction and installation guide
    • Write Sphinx API docs
    • Publish the docs to ReadTheDocs and add the README badge
  • Make it clear in the README and the manual that the PyPI version is the recommended form for installation and that updates are kept small so they can be released promptly.
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