Skip to content

Fix Sphinx/Doxygen documentation build warnings treated as errors#4

Merged
Cadons merged 2 commits into
devfrom
copilot/fix-warnings-and-errors
Mar 9, 2026
Merged

Fix Sphinx/Doxygen documentation build warnings treated as errors#4
Cadons merged 2 commits into
devfrom
copilot/fix-warnings-and-errors

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 9, 2026

sphinx-build -W --keep-going fails due to accumulated warnings across RST files and Doxygen C++ comments. This addresses all warning sources.

Sphinx RST warnings

  • Duplicate autosection labels — added autosectionlabel_prefix_document = True to conf.py; common titles like Attributes, Usage, Templating, Utilities collided across files
  • shipping_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/#RRGGBBAA as \#RRGGBB/\#RRGGBBAA; bare #NAME is parsed as a cross-reference link by Doxygen
  • docraft_template_engine.h — removed duplicate consecutive /** */ doc blocks on get_template_variable, remove_template_variable, has_template_variable, clear_template_variables; escaped <Image> HTML tags; added missing @param item
  • docraft_table.h — added missing @param background to add_title_node, add_htitle_node, add_content_node
  • docraft_parser_helpers.h — fixed mismatched @param names: color_attrcolor for is_hex_color, color_strcolor_attr for get_docraft_color

Doxyfile

  • Changed WARN_LOGFILE from ./build/doxygen/warnings.log (directory never created) to ./doxy_files/warnings.log (Doxygen's own OUTPUT_DIRECTORY, created automatically)
Original prompt

Reference: https://github.com/Cadons/Docraft/actions/runs/22842657720/job/66251874012#step:7:1

Correggi i warning e gli errori


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

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
@Cadons Cadons marked this pull request as ready for review March 9, 2026 07:35
@Cadons Cadons merged commit 46c7fda into dev Mar 9, 2026
8 checks passed
@Cadons Cadons deleted the copilot/fix-warnings-and-errors branch March 10, 2026 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants