Skip to content

Doc issues fail CI#8161

Draft
alliepiper wants to merge 6 commits intoNVIDIA:mainfrom
alliepiper:7053_doc_ci_fail
Draft

Doc issues fail CI#8161
alliepiper wants to merge 6 commits intoNVIDIA:mainfrom
alliepiper:7053_doc_ci_fail

Conversation

@alliepiper
Copy link
Contributor

Fixes #7053

Summary

  • Fix Doxygen @param mismatches across libcudacxx, cudax, CUB, and Thrust headers
  • Fix Sphinx warnings: undefined labels, missing toctree entries, RST formatting errors
  • Add -W (warnings-as-errors) to the docs build so regressions fail CI
  • Skip generating API pages for 3 symbols with breathe-unparseable C++ declarations
  • Suppress 2 breathe warning categories (cpp.duplicate_declaration, docutils) that
    cannot be fixed in source

Full gen_docs.bash build (Doxygen + Sphinx -W) passes with zero warnings.

Add missing @param tags, fix param name mismatches, remove stale
params, and correct Doxyfile inputs across libcudacxx, cudax, CUB,
and Thrust headers. Replace duplicate overload doc blocks in copy.h
and fill.h with @overload. Fix minor doc formatting in CUB device
headers and Python sort docstrings.
Add -W (warnings-as-errors) to SPHINXOPTS and quote paths in the
sphinx build command. Replace toctree with ref links in auto-generated
group pages to eliminate duplicate-toctree warnings. Fix undefined
label references, add missing toctree entries for numeric overflow
docs, fix RST formatting errors, and add stub anchors for in-progress
container and graph features.
Skip generating API pages for 3 symbols whose Doxygen XML produces
C++ declarations that breathe/Sphinx cannot parse (function-pointer
typedefs, variable templates with SFINAE expressions). Suppress
cpp.duplicate_declaration and docutils warning categories that arise
from breathe architecture limitations. Remove container.rst stub
anchors that collide with breathe-generated labels.

Full doc build (Doxygen + Sphinx -W) now passes with zero warnings.
@copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Mar 25, 2026

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@cccl-authenticator-app cccl-authenticator-app bot moved this from Todo to In Progress in CCCL Mar 25, 2026
Copy link
Contributor Author

@alliepiper alliepiper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok to test

@alliepiper alliepiper changed the title Fix documentation build to pass with warnings-as-errors Doc issues fail CI Mar 25, 2026
@alliepiper
Copy link
Contributor Author

/ok to test

@alliepiper
Copy link
Contributor Author

/ok to test

@github-actions
Copy link
Contributor

🥳 CI Workflow Results

🟩 Finished in 1h 28m: Pass: 100%/374 | Total: 8d 00h | Max: 1h 20m | Hits: 89%/397465

See results here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

[BUG]: Doc issues do not fail CI

1 participant