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

Allow docs preview to be generated even if docs build fails #5870

Open
user27182 opened this issue Apr 5, 2024 · 0 comments
Open

Allow docs preview to be generated even if docs build fails #5870

user27182 opened this issue Apr 5, 2024 · 0 comments
Labels
maintenance Low-impact maintenance activity

Comments

@user27182
Copy link
Contributor

Describe what maintenance you would like added.

Previewing the docs with @pyvista-bot preview is great, but a preview is currently only generated if the build succeeds. However, even if warnings or errors are generated by the build (and the build "fails"), the docs are usually still in a viewable state, but can't be viewed simply because the failure causes the bot not to generated the preview.

Further, with build times taking 2hrs recently (see #5868), it can be painful to wait 2hrs for a preview only for it not to be generated because of a simple rst formatting warning.

As a workaround, draft PRs can temporarily remove the -W --keep-going option from the makefile:

DEFAULTS = -w sphinx_warnings.txt -W --keep-going

in order to allow the build to succeed with warnings, thus allowing the bot to generate the preview. But, it would be nice not to have to use a workaround like this.

Links to source code.

No response

Pseudocode or Screenshots

No response

@user27182 user27182 added the maintenance Low-impact maintenance activity label Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Low-impact maintenance activity
Projects
None yet
Development

No branches or pull requests

1 participant