consider ignoring sphinx docs warnings #15655
Metadata
Metadata
Assignees
Labels
Desirable enhancement or fix. May not be included in next release.Desirable enhancement or fix. May not be included in next release.Improvement to the documentation for an API.Improvement to the documentation for an API.‘Nice-to-have’ improvement, new feature or different behavior or design.‘Nice-to-have’ improvement, new feature or different behavior or design.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Summary of the issue
We currently have a docs check, that can fail due to sphinx formatting. The docstrings are provided by product teams and are outside the control of our generator.
To make sure this doesn't block our library releases, we should consider ignoring warnings (where reasonable), or consider a way to raise the warning earlier in the process, so the product team will fix it in the source