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

Docs build should be checked by CI #222

Open
jni opened this issue Nov 21, 2023 · 0 comments
Open

Docs build should be checked by CI #222

jni opened this issue Nov 21, 2023 · 0 comments

Comments

@jni
Copy link
Owner

jni commented Nov 21, 2023

We've had a few cases where warnings were popping up during docs build, or, in extreme cases, the documentation notebooks failed to run altogether, but the docs build passed. We should experiment with ways to ensure that the docs are being built correctly.

  1. pytest-doctestplus, as suggested by @ns-rse, might be able to test the running of the code in markdown.
  2. alternatively, we can check sphinx config to see whether there is a way to make the docs build fail if a notebook contains errors.
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