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

Use sphinx.ext.doctest to test examples in the docs #90

Closed
janluke opened this issue Sep 5, 2021 · 1 comment
Closed

Use sphinx.ext.doctest to test examples in the docs #90

janluke opened this issue Sep 5, 2021 · 1 comment
Labels
chore documentation Improvements or additions to documentation

Comments

@janluke
Copy link
Owner

janluke commented Sep 5, 2021

No description provided.

@janluke janluke added documentation Improvements or additions to documentation chore labels Sep 5, 2021
@janluke janluke changed the title Use sphinx.ext.doctest to test examples in the docs Use sphinx.ext.doctest to test examples in the docs Sep 5, 2021
@jsonvillanueva jsonvillanueva mentioned this issue Sep 6, 2021
Closed
@janluke
Copy link
Owner Author

janluke commented Oct 23, 2021

Since we are already extensively testing the library, doc tests are probably reduntant. What we really need is to ensure that examples are actually consistent with the library and that's possible if we generate the output:

@janluke janluke closed this as completed Nov 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
chore documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Integrate sphinx.ext.doctest for a few example snippets jsonvillanueva/cloup
1 participant
@janluke