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

Add documentation for API Reference #19

Closed
Ambro17 opened this issue Sep 18, 2020 · 0 comments · Fixed by #21
Closed

Add documentation for API Reference #19

Ambro17 opened this issue Sep 18, 2020 · 0 comments · Fixed by #21
Labels
documentation Improvements or additions to documentation

Comments

@Ambro17
Copy link
Owner

Ambro17 commented Sep 18, 2020

Use pdoc3 to have a github-hosted documentation with an API Reference to fallback in case of any usage question
@Ambro17 Ambro17 added the documentation Improvements or additions to documentation label Sep 18, 2020
@Ambro17 Ambro17 mentioned this issue Sep 19, 2020
Merged
Ambro17 added a commit that referenced this issue Sep 19, 2020
@Ambro17
#19 Add Docs (#21)
b1b09d9 
* 🚧 Add docs

* 📚 Add docstrings to public functions

* 📷 Add logo

* 📚 Generate docs with pdoc3 and custom template

* 🚀 Add target to update docs

* 📚 Update README for better mobile experience.
It also is smaller now that we have proper docs on another page

* 📚 Add docs section to README
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

Successfully merging a pull request may close this issue.

#19 Add Docs Ambro17/slackify
1 participant
@Ambro17