Skip to content

Fix failing docs build due to profiling clash - #1161

Merged
TimMonko merged 1 commit into
napari:mainfrom
TimMonko:fix/clashing-profiling
Oct 11, 2026
Merged

TimMonko merged 1 commit into
napari:mainfrom
TimMonko:fix/clashing-profiling

Conversation

@TimMonko

Copy link
Copy Markdown
Member

References and relevant issues

The docs build is failing, see something like: https://github.com/napari/docs/actions/runs/38021915215
I think it's because python 3.15 adds the profiling module? Maybe we want to rename ours regardless. see:

docs/developers/contributing/index.md:170: WARNING: Multiple matches found for 'profiling':
    python:py:module:profiling, python:std:label:profiling [myst.iref_ambiguous]

Description

profiling is caushing a clash now that 3.15 is out on base python. The actual problem though is that the links were not even pointing to the correct page. performance/profiling.md has the label (napari-profiling)= so this PR updates to actually point at the correct labels.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 10, 2026
@TimMonko TimMonko added this to the 0.10.0 milestone Oct 10, 2026

@Czaki Czaki left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are you sure that profiling is intended to point to Python's documentation, not Python one?

I think that we should keep some references to Python documentation.

We might change the intersphinx configuration to point to the given version of Python (or be ready to fix this in October every year).

@lundybernard

Copy link
Copy Markdown
Contributor

@Czaki It looks like profiling was intended to point to napari-profiling not the Python docs. #338 renamed the profiling name and it looks like a simple miss that failed silently because 'profiling' found the python docs.

Looking at links in the 'Monitoring vs. profiling" section, the second link specifically says "our profiling documentation" but links to the C-API docs. https://napari.org/stable/howtos/perfmon.html#monitoring-vs-profiling. If you do want to keep a link to the Python docs, I would add it to the profiling page not leave it in performance monitoring.

The two links on that page leading to the same page is awkward. I would drop the first link or point it to an 'into to profiling' article, and have the 2nd point to napari-profiling as it is clearly meant to.

@TimMonko

Copy link
Copy Markdown
Member Author

@lundybernard thank you for a most thorough search. @Czaki, I've done a double check, and I have a hard time reading it under any intent to point to Python docs, especially with language like "our profiling" page and things. I think it was just missed is a page-name migration.
It's fine to have references to Python documentation, sure, but I don't think that was the intent here.

@TimMonko
TimMonko merged commit df70142 into napari:main Oct 11, 2026
9 checks passed
@TimMonko
TimMonko deleted the fix/clashing-profiling branch October 11, 2026 19:31
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.

4 participants