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

Improve doctests handling #73

Open
HelgeKrueger opened this issue Dec 22, 2024 · 1 comment
Open

Improve doctests handling #73

HelgeKrueger opened this issue Dec 22, 2024 · 1 comment

Comments

@HelgeKrueger
Copy link
Contributor

Note: I don't expect this to be easily doable in this project. It would either belong into pytest or maturin. This is just where this issue arose for me.

This issue arose while implementing #72

By adding

[tool.pytest.ini_options]
addopts = '--doctest-glob="*.rst"'

to pyproject.toml, one can run the docstrings in docs/index.rst using pytest. See here.

Unfortunately, this doesn't run the doctests in src/lib.rs.

Question: Can one adopt the tooling to also run these?

@messense
Copy link
Owner

Maybe we can run doctests using https://github.com/twmr/pytest-sphinx?

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

No branches or pull requests

2 participants