Treat warnings as error in doc generation #2097
Conversation
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
There was a problem hiding this comment.
Pull Request Overview
This PR configures Sphinx documentation generation to treat warnings as errors by adding the -W flag to the SPHINXOPTS variable. This ensures that documentation builds fail when warnings are present, helping maintain documentation quality and catch issues early in the development process.
- Added the
-Wflag toSPHINXOPTSto enable strict warning handling
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This comment has been minimized.
This comment has been minimized.
airlock-confluentinc
bot
force-pushed
the
dev_doc-generation-failure-scenario
branch
from
d491557 to
60ff184
Compare
This comment has been minimized.
This comment has been minimized.
airlock-confluentinc
bot
force-pushed
the
dev_doc-generation-failure-scenario
branch
from
60ff184 to
2104da8
Compare
pranavrth
changed the title
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
docs/conf.py
Outdated
| # further. For a list of options available for each theme, see the | ||
| # documentation. | ||
| html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | ||
| # html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
There was a problem hiding this comment.
I'm assuming the theme still loads from line 131 and this plus import becomes unnecessary. Did you double check the rendering is preserving the theme? If so I'd just delete rather than comment these lines
There was a problem hiding this comment.
I built the documentation before and after the removal and compared both versions visually and using vimdiff. Only a minor difference was observed: the character used to represent links after section headers had changed. This is not a significant issue, so we can proceed with removing that part.
Analysis Details0 Issues
Coverage and Duplications
Project ID: confluent-kafka-python |
2 participants
No description provided.