Skip to content

Fix documentation build warnings and errors#2333

Merged
antonwolfy merged 6 commits into
masterfrom
fix-rendering-issues
Jul 9, 2026
Merged

Fix documentation build warnings and errors#2333
antonwolfy merged 6 commits into
masterfrom
fix-rendering-issues

Conversation

@antonwolfy

@antonwolfy antonwolfy commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

The documentation build on master was completing with 2 errors and 123 warnings (see failing-ish run).
Although the job did not fail (Sphinx is not run with -W), several of these were silently degrading the published docs — dropping content and leaving empty API entries.

This PR fixes the Python-facing documentation defects. The build now completes with 0 errors and 108 warnings (the remaining 108 are pre-existing Doxygen/doxyrest C-API cross-reference noise in libsyclinterface, tracked separately).

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to an issue with a reproducer?
  • Have you tested your changes locally for CPU and GPU devices?
  • Have you made sure that new changes do not introduce compiler warnings?
  • Have you checked performance impact of proposed changes?
  • Have you added documentation for your changes, if necessary?
  • Have you added your changes to the changelog?
  • If this PR is a work in progress, are you opening the PR as a draft?

@antonwolfy antonwolfy self-assigned this Jul 8, 2026
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

Deleted rendered PR docs from intelpython.github.com/dpctl, latest should be updated shortly. 🤞

@coveralls

coveralls commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Coverage Status

coverage: 74.579%. remained the same — fix-rendering-issues into master

@antonwolfy antonwolfy changed the title Resolve warnings from documentation build Fix documentation build warnings and errors Jul 8, 2026
@antonwolfy antonwolfy marked this pull request as ready for review July 8, 2026 18:16

@ndgrigorian ndgrigorian left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@ndgrigorian

Copy link
Copy Markdown
Collaborator

I'll note there are still 108 warnings but they seem to be from doxygen

@antonwolfy antonwolfy merged commit 06e657d into master Jul 9, 2026
94 of 97 checks passed
@antonwolfy antonwolfy deleted the fix-rendering-issues branch July 9, 2026 08:00
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.

3 participants