Repository navigation
Fix failing docs build due to profiling clash - #1161
Conversation
Czaki
left a comment
There was a problem hiding this comment.
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).
|
@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. |
|
@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. |
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:
Description
profilingis 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.mdhas the label(napari-profiling)=so this PR updates to actually point at the correct labels.