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

Documentation #5

Open
diegojromerolopez opened this issue Jun 19, 2021 · 0 comments
Open

Documentation #5

diegojromerolopez opened this issue Jun 19, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@diegojromerolopez
Copy link
Owner

While this project is easy to use and some documentation can be found in the README.md file, it needs some documentation.

Maybe create the folder docs and use sphinx. Thus, upload to readthedocs.io

Some use-cases and examples would be good too.
@diegojromerolopez diegojromerolopez added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Jun 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@diegojromerolopez