Fix Sphinx/Doxygen documentation build warnings treated as errors#4
Merged
Conversation
Co-authored-by: Cadons <43477517+Cadons@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix warnings and errors in code
Fix Sphinx/Doxygen documentation build warnings treated as errors
Mar 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
sphinx-build -W --keep-goingfails due to accumulated warnings across RST files and Doxygen C++ comments. This addresses all warning sources.Sphinx RST warnings
autosectionlabel_prefix_document = Truetoconf.py; common titles likeAttributes,Usage,Templating,Utilitiescollided across filesshipping_label.rst— added missing blank line between code block and following section heading (docutils "explicit markup ends without blank line")Doxygen C++ comment warnings
docraft_color.h/docraft_parser_helpers.h— escaped#RRGGBB/#RRGGBBAAas\#RRGGBB/\#RRGGBBAA; bare#NAMEis parsed as a cross-reference link by Doxygendocraft_template_engine.h— removed duplicate consecutive/** */doc blocks onget_template_variable,remove_template_variable,has_template_variable,clear_template_variables; escaped<Image>HTML tags; added missing@param itemdocraft_table.h— added missing@param backgroundtoadd_title_node,add_htitle_node,add_content_nodedocraft_parser_helpers.h— fixed mismatched@paramnames:color_attr→colorforis_hex_color,color_str→color_attrforget_docraft_colorDoxyfile
WARN_LOGFILEfrom./build/doxygen/warnings.log(directory never created) to./doxy_files/warnings.log(Doxygen's ownOUTPUT_DIRECTORY, created automatically)Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.