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 page using mkdocs #15

Merged
merged 17 commits into from
Oct 24, 2024
Merged

Add documentation page using mkdocs #15

merged 17 commits into from
Oct 24, 2024

Conversation

jotonedev
Copy link
Owner

  • Improve docstrings
  • Add documentation page
  • Various fix & improvements

@jotonedev jotonedev self-assigned this Oct 23, 2024
@jotonedev jotonedev linked an issue Oct 23, 2024 that may be closed by this pull request
Write documentation #13
Closed
@jotonedev jotonedev added the documentation Improvements or additions to documentation label Oct 23, 2024
@jotonedev
Copy link
Owner Author

For now, the documentation will be limited to the API reference. Once the library is completed, the rest of the documentation will be written.

@jotonedev jotonedev marked this pull request as ready for review October 24, 2024 20:02
@jotonedev jotonedev merged commit 4e0bc10 into main Oct 24, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jotonedev jotonedev

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Write documentation
1 participant
@jotonedev