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

Improved docs #14

Merged
merged 1 commit into from
Nov 3, 2023
Merged

Improved docs #14

merged 1 commit into from
Nov 3, 2023

Conversation

Somtom
Copy link
Collaborator

@Somtom Somtom commented Nov 2, 2023

Problem

Our current setup only has a README documentation which is pretty incomplete. We need to provide better docs for our users.

Closes: #8

What changed

Added a sphinx setup and added documentation for the existing functionality

@Somtom Somtom self-assigned this Nov 2, 2023
@github-pages github-pages bot temporarily deployed to github-pages November 2, 2023 12:49 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 3, 2023 07:05 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 3, 2023 07:15 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 3, 2023 07:29 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 3, 2023 07:32 Inactive
@github-pages github-pages bot temporarily deployed to github-pages November 3, 2023 07:35 Inactive
@Somtom Somtom merged commit 97c3c8e into main Nov 3, 2023
5 checks passed
@Somtom Somtom deleted the improved-docs branch November 3, 2023 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation
1 participant