-
Notifications
You must be signed in to change notification settings - Fork 27
Description
Currently when the docs are built it produces thousands of lines of output related to the 682 warnings. Ideally, there should be 0 warnings stemming from the documentation created for the project. Many of warnings stem from renamed models or docstrings with duplicated definitions, and much of this identifies the specific attributes or errors from the docs build but have gone unaddressed when they were introduced.
When there are so many warnings it is difficult to diagnose newly introduced build errors and impossible to catch these errors as they occur in the build process, which means they are not discovered until the docs are inspected. The docs need to be cleaned up to have a most a few warnings stemming from acceptable issues, not uninspected documentation.