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

Creating basic documentation with examples of library usage #3

Open
danfimov opened this issue Sep 17, 2023 · 0 comments
Open

Creating basic documentation with examples of library usage #3

danfimov opened this issue Sep 17, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@danfimov
Copy link
Owner

danfimov commented Sep 17, 2023 •
edited
Loading

  • Project README.md with description, example of usage and little shields about python version and linters/tests statuses from last workflow;
  • Examples in folder examples. Don't forget about deps in special group in pyproject.toml;
  • Docs with deep dive to project features.
@danfimov danfimov added the documentation Improvements or additions to documentation label Sep 17, 2023
@danfimov danfimov changed the title Create basic documentation with examples of library usage Creating basic documentation with examples of library usage Sep 17, 2023
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@danfimov