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.

Sign up for GitHub

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

Jump to bottom

Document released readers #14

Closed
drewejohnson opened this issue Sep 19, 2017 · 2 comments
Closed

Document released readers #14

drewejohnson opened this issue Sep 19, 2017 · 2 comments
Assignees
@drewejohnson
Labels
documentation
Milestone
Release version 0...

Comments

@drewejohnson
Copy link
Collaborator

drewejohnson commented Sep 19, 2017 •
edited
Loading

Provide documentation through Sphinx describing the various readers, their limitations and features, as well as some helpful examples.
@drewejohnson drewejohnson added this to the Version 1.0.0 milestone Sep 19, 2017
@drewejohnson drewejohnson mentioned this issue Oct 10, 2017
Merged
@drewejohnson drewejohnson modified the milestones: Version 1.0.0, Release version 0.1.0 Dec 8, 2017
@drewejohnson drewejohnson self-assigned this Dec 8, 2017
@drewejohnson
Copy link
Collaborator Author

Examples were included as jupyter notebooks in #49. Need to find some way to bundle them in the documentation automatically.

Export to rst?

@drewejohnson drewejohnson mentioned this issue Dec 10, 2017
Merged
@drewejohnson
Copy link
Collaborator Author

This should be an ongoing process with each reader. However, with the closure of #6 / #65, and the pending release of version 0.1.0, this issue will be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@drewejohnson drewejohnson

Labels
documentation
Projects
None yet
Milestone
Release version 0.1.0
Development

No branches or pull requests
1 participant
@drewejohnson