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

Introduce Sphinx Doctest #20

Open
CarliJoy opened this issue Nov 29, 2020 · 0 comments
Open

Introduce Sphinx Doctest #20

CarliJoy opened this issue Nov 29, 2020 · 0 comments

Comments

@CarliJoy
Copy link
Owner

We have some code examples in the README.
It would be great if this examples would be checked automatically with doctest

But for this we would need to convert the README probably to rst file, which I personally don't like that much.
On the other hand the README.md is already converted to an rst file during the build of the code.

Therefore it would be quite easy.

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

No branches or pull requests

1 participant