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

Improve Documentation #11

Open
lgrahl opened this issue Jun 8, 2015 · 0 comments
Open

Improve Documentation #11

lgrahl opened this issue Jun 8, 2015 · 0 comments

Comments

@lgrahl
Copy link
Owner

lgrahl commented Jun 8, 2015

There are already docstrings in the code and most of the (Python) code is well documented. Let's use Sphinx to parse and generate the API documentation and move all relevant parts from the wiki page and the readme file into that documentation.

We could definitely use some help from scripters to get a proper Getting Started section. Any kind of feedback is much appreciated.

@lgrahl lgrahl changed the title Documentation (including API) Improve Documentation Jun 8, 2015
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