Warn when building with a table of contents which is going to have a red warning #125
-
I recently converted documentation for multiple projects to use the Furo theme. It would have been useful when doing this task if there had been a build-time warning that my documentation was going to have a nasty red box. |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 2 replies
-
Hmm! This is an interesting idea, but this would be non-trivial to implement; which is why I think this isn't worthwhile. While this would certainly be a nice quality-of-life improvement for documentation authors porting the documentation, I don't think the maintenance overhead of overriding a provided-by-default sphinx directive would justify that benefit. |
Beta Was this translation helpful? Give feedback.
Hmm! This is an interesting idea, but this would be non-trivial to implement; which is why I think this isn't worthwhile.
While this would certainly be a nice quality-of-life improvement for documentation authors porting the documentation, I don't think the maintenance overhead of overriding a provided-by-default sphinx directive would justify that benefit.