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 docs #1

Open
ixjlyons opened this issue Jun 16, 2017 · 0 comments
Open

Add docs #1

ixjlyons opened this issue Jun 16, 2017 · 0 comments

Comments

@ixjlyons
Copy link
Member

Docs would be very useful for demonstrating functionality provided.

  • Simple option: write an example script per function, put the generated figures in master, then put them in the README. I'm not a huge fan of this idea, but it is easy.
  • Slightly less simple option: write example scripts, put generated figures in gh-pages branch, and generate a site either manually or with a commit hook or something.
  • Sphinx docs on readthedocs: write some actual docs with example scripts, use mpl's plot directive to generate plots. A bit painful to set up but shouldn't be too bad -- just seems overkill if this doesn't go anywhere.
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