readthedocs.org: Exclude epub builds from "fail_on_warning"

We just fixed a warning in ePub builds in https://github.com/readthedocs/readthedocs.org/pull/9812

But it didn’t last long until the next warning started to show up: https://readthedocs.org/projects/docs/builds/18929188/

It seems that the epub builder is just very sensitive to the many extensions and patterns that are only tested for html builders.
It might be useful, if we had an option fail_on_warning_epub that would deliberate add this behavior to epub builds.

In my experience, it should not be a default that fail_on_warning fails on epub builds.

About this issue

Original URL
State: open
Created 2 years ago
Comments: 15 (15 by maintainers)

Most upvoted comments

Summarizing a convo with @humitos just now:

The best possible scenario for configuring warnings should not change current behavior (default should be that warnings also fail on epub). But we can create a new version of fail_on_warning as a list of formats:

fail_on_warning:
  - pdf
  - html
  - epub

This can provide the granularity for projects that do not want to be surprised by branch builds failing when PR builds succeeded.

@humitos points out that there is a value in keeping the epub on our user docs. I agree that it’s great to have ePub builds but I’d rather disable it for now until we can have the above feature implemented.

benjaoming on Jan 3, 2023

I think it’s because I added references inside a directive belonging to an extension that doesn’t produce output for epub. So it’s invalid in a way that we want to ignore?

benjaoming on Dec 16, 2022