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

Sphinx documentation #1

Open

bmtgoncalves opened this issue Apr 18, 2024 · 0 comments

Labels

Member

bmtgoncalves commented Apr 18, 2024

Now that integration with readthedocs is complete, we have to start populating the documentation. There are a few specific things that we should add:

Brief overview of the structure of the library
High level description of the three main modules
Explanation of the arguments for each method
Examples of the way to use the package. We can refer to the blog posts for examples of the full functionality

With some luck, the documentation can also serve as the starting point for defining a complete set of tests

bmtgoncalves added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment