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 generation #17

Open
guoguo12 opened this issue Apr 6, 2017 · 0 comments
Open

Improve documentation generation #17

guoguo12 opened this issue Apr 6, 2017 · 0 comments

Comments

@guoguo12
Copy link
Owner

guoguo12 commented Apr 6, 2017

Currently, the documentation in the readme needs to be updated manually every time a docstring changes. This is bad. For consistency and convenience, we should generate the documentation page directly from the source using pydoc.

The documentation also belongs on its own page. It shouldn't be crammed into the readme.

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