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

Use sphinx-code-include to make examples always correct #322

Open
BenGalewsky opened this issue Sep 27, 2023 · 0 comments
Open

Use sphinx-code-include to make examples always correct #322

BenGalewsky opened this issue Sep 27, 2023 · 0 comments

Comments

@BenGalewsky
Copy link
Contributor

The documentation of examples for ServiceX client can often go out of date. Use this sphinx-code-include to render the example source code directly into the page.

Update the examples pages to use this.

Extra Credit

Use pytest to make sure the examples execute before building the docs!

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

1 participant