canonical / craft-parts

https://canonical-craft-parts.readthedocs-hosted.com
GNU Lesser General Public License v3.0
11 stars 38 forks source link

Cleanup warning when building docs #347

Open tigarmo opened 1 year ago

tigarmo commented 1 year ago

The current sphinx-build output contains a lot of warnings; some of them can be disregarded but some of them can be major, like disabling the autogenerated docs from the code altogether (see #346). Ideally we should cleanup the warnings and then build with -W so that new warnings fail the build. Cleaning up the warnings isn't as straightforward as we might like because some of them are from the various sphinx plugins interacting badly with Pydantic.

syncronize-issues-to-jira[bot] commented 6 months ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-2972.

This message was autogenerated