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

Implement doctest #279

Open
tinmarr opened this issue Jul 20, 2022 · 0 comments
Open

Implement doctest #279

tinmarr opened this issue Jul 20, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation internal This change is internal and doesn't affect the API medium priority This is a medium priority issue

Comments

@tinmarr
Copy link
Member

tinmarr commented Jul 20, 2022 •
edited
Loading

Sphinx has a doctest extension that allows our code blocks to be tested.

We need to implement this and add it to the CI.

Also when doing this, update the existing tutorials to use any new rubato API best practices.
@tinmarr tinmarr added the documentation Improvements or additions to documentation label Jul 20, 2022
@tinmarr tinmarr added this to the v1.0.0 milestone Oct 14, 2022
@tinmarr tinmarr mentioned this issue Oct 16, 2022
Closed
@tinmarr tinmarr added internal This change is internal and doesn't affect the API medium priority This is a medium priority issue labels Nov 8, 2022
@tinmarr tinmarr changed the title DOCUMENTATION: Implement doctest Implement doctest Nov 8, 2022
@mrElnekave mrElnekave removed this from the v1.0.0 milestone Dec 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation internal This change is internal and doesn't affect the API medium priority This is a medium priority issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tinmarr @mrElnekave