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

Add Sphinx-generated documentation #68

Open
diazona opened this issue Jul 14, 2023 · 0 comments
Open

Add Sphinx-generated documentation #68

diazona opened this issue Jul 14, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@diazona
Copy link
Contributor

diazona commented Jul 14, 2023

I would like to have HTML documentation generated by Sphinx for the stable release. While the README is doing perfectly fine at explaining how to use the package (and thus this isn't necessary), generating docs with Sphinx looks nicer and gives us more flexibility to expand the docs later.

@diazona diazona added the documentation Improvements or additions to documentation label Jul 14, 2023
@diazona diazona added this to the v1.0 milestone Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant