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

use sphinx for the documentation #62

Open
maxbachmann opened this issue Mar 2, 2022 · 0 comments
Open

use sphinx for the documentation #62

maxbachmann opened this issue Mar 2, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@maxbachmann
Copy link
Member

The current documentation is far from complete (even though the code is documented) and is very cluttered. The documentation should use sphinx similar to https://github.com/maxbachmann/RapidFuzz and document all the publicly available APIs.

@maxbachmann maxbachmann added the documentation Improvements or additions to documentation label Mar 2, 2022
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