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

Make a sphinx-based documentation #39

Open
mmlouamri opened this issue May 25, 2023 · 0 comments
Open

Make a sphinx-based documentation #39

mmlouamri opened this issue May 25, 2023 · 0 comments
Assignees
@mmlouamri
Labels
documentation Improvements or additions to documentation

Comments

@mmlouamri
Copy link
Collaborator

Currently, the documentation is available as docstrings only. A Sphinx-based website can provide a user-friendly interface with search functionality, navigation menus, and cross-referencing capabilities, making it easier for developers and beginners to explore and understand the package.
@mmlouamri mmlouamri added the documentation Improvements or additions to documentation label May 25, 2023
@mmlouamri mmlouamri self-assigned this May 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mmlouamri mmlouamri

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

No branches or pull requests
1 participant
@mmlouamri