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

Prose docs #7

Open
sixpearls opened this Issue Apr 12, 2019 · 2 comments

Comments

Projects
None yet
2 participants
@sixpearls
Copy link
Owner

sixpearls commented Apr 12, 2019

May not be neceessary depending on the detail of the main class's docstring

@ixjlyons

This comment has been minimized.

Copy link
Collaborator

ixjlyons commented Apr 14, 2019

I like the idea of having a page with some info on applications, references, and example use cases. With sphinx-gallery, we could just spruce up the example scripts with some notes and call that sufficient for prose docs.

@sixpearls

This comment has been minimized.

Copy link
Owner Author

sixpearls commented Apr 15, 2019

Yes, I was definitely thinking at least some motivation, application, references, and examples would be necessary in the docs. I was thinking they could go in the docstring of the main class to match the scipy style, but I'm not attached.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.