kivy/kivy — pull request #594 by aspidites (2012-07-28 07:57:02+00:00)
Title: No Warnings, Again

This time, I decided to use a hidden TOC. From what I understood of tito's comments, he was concerned about docs being skipped all together when processing them. There are now two ways to handle the issue:

- keep exclude_patterns enabled: The way I see it, the docs should in fact be excluded since they aren't yet being used. Once they are used, simply remove them from exclude patterns. I'm not sure that these files not getting regenerated is relevant, as they aren't in use in the first place.
- disable exclude_patterns and enable hiddne toctree: sources/index has a hidden toctree which serves the same purpose (in this use case) as exclude_patterns does in conf.py. In case my previous points aren't sufficient, I thought it might be worth trying this out instead.

The reason I am so adamant about having warnings treated as errors by default is that its much easier to uncover documentation errors (such as the fact that certain labels didn't exist when I implemented these changes). While I could enable such strictness on my end alone, I'm not sure its fair that I (or anyone else) have to fix documentation errors after the fact if they could have been fixed sooner.

Your thoughts?