Skip to content

Fix building docs with PyQt6 - #1102

Merged
TimMonko merged 1 commit into
napari:mainfrom
Czaki:fix_qt_6
Aug 10, 2026
Merged

Fix building docs with PyQt6#1102
TimMonko merged 1 commit into
napari:mainfrom
Czaki:fix_qt_6

Conversation

@Czaki

@Czaki Czaki commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

References and relevant issues

Unlock napari/shared-workflows#29

Description

The build docs against PyQt6 fails with such warnings (and we treat warnings as errors).

docstring of napari.qt.QtToolTipLabel.Shadow.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtToolTipLabel.Shadow.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtToolTipLabel.Shape.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtToolTipLabel.Shape.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtViewer.Shadow.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtViewer.Shadow.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtViewer.Shape.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtViewer.Shape.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtViewerButtons.Shadow.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtViewerButtons.Shadow.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtViewerButtons.Shape.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
docstring of napari.qt.QtViewerButtons.Shape.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]

This PR uses our machinery to filter out problematic methods.

It improves the Qt filter mechanism to not filter outside the napari.qt module

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 10, 2026
@Czaki Czaki added this to the 0.9.0 milestone Aug 10, 2026
@TimMonko

TimMonko commented Aug 10, 2026

Copy link
Copy Markdown
Member

@napari-bot make docs

@TimMonko TimMonko added the Full docs preview/ready to merge Adding this label will trigger a full docs build for previewing changes. Also @napari-bot make html label Aug 10, 2026
@Czaki

Czaki commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

@TimMonko it builds

@TimMonko TimMonko left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🍻 thanks for the ping! So glad to have this rolling in.
ping me when next PR is ready

@TimMonko
TimMonko merged commit ff7d690 into napari:main Aug 10, 2026
9 checks passed
@github-actions github-actions Bot removed the Full docs preview/ready to merge Adding this label will trigger a full docs build for previewing changes. Also @napari-bot make html label Aug 10, 2026
melissawm pushed a commit that referenced this pull request Aug 11, 2026
# References and relevant issues

follow-up #1102

# Description

Just change circleci configuration in napari/docs to use PyQt6.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants