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 basic documentation via sphinx #30

Open
lukasheinrich opened this issue May 18, 2020 · 2 comments
Open

add basic documentation via sphinx #30

lukasheinrich opened this issue May 18, 2020 · 2 comments
Assignees
Labels
docs Documentation related

Comments

@lukasheinrich
Copy link
Collaborator

No description provided.

@matthewfeickert matthewfeickert added the docs Documentation related label May 19, 2020
@matthewfeickert matthewfeickert self-assigned this Apr 17, 2021
@eduardo-rodrigues
Copy link
Member

Hi folks, just browsing the outstanding issues ... let me comment on this: for a small package such as this one you could also make your life easier and provide documentation via one or two notebooks (aside quick get-started snippets in the README, which are always good for a first contact with a package). My 2 cents :-).

@eduardo-rodrigues
Copy link
Member

What do you think of my comment above, @matthewfeickert and @lukasheinrich?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

No branches or pull requests

3 participants