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

Execute docs examples in CI #2610

Open
MartinThoma opened this issue Apr 30, 2024 · 1 comment
Open

Execute docs examples in CI #2610

MartinThoma opened this issue Apr 30, 2024 · 1 comment

Comments

@MartinThoma
Copy link
Member

I want the docs to be complete, meaning all code blocks have all imports.

See https://pypi.org/project/pytest-examples/ - I think it's used by pydantic

That should also ensure that we don't have deprecated code in there + that no typos happen.

@stefan6419846
Copy link
Collaborator

Sphinx seems to have some built-in support for something like this as well: https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html

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