Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Build Errors. #1358

Open
scott-huberty opened this issue Dec 20, 2024 · 2 comments
Open

Documentation Build Errors. #1358

scott-huberty opened this issue Dec 20, 2024 · 2 comments

Comments

@scott-huberty
Copy link
Contributor

scott-huberty commented Dec 20, 2024

As seen in #1357 and #1355

the docs-build job is giving this error:

/home/circleci/project/mne_bids/path.py:docstring of mne_bids.BIDSPath.root:1: WARNING: py:class reference target not found: pathlib._local.Path [ref.class]

From local tests, my current hypothesis is that this has something to do with Python 3.13, which the CircleCI runner uses:

Because Locally, on python 3.10, I don't get the error above, and the docstring of BIDSPath.root correctly hyperlinks to the python docs:

Screenshot 2024-12-20 at 11 05 49 AM

on Python 3.13 it looks like this ("Path" does not hyperlink):

Screenshot 2024-12-20 at 11 10 54 AM

I don't think I have the skill to track down the source of that issue. But we can force the CircleCI runner that deploys docs-build to user a lower version of Python as a work around?

@drammock
Copy link
Member

drammock commented Dec 20, 2024

see here for explanation: sphinx-doc/sphinx#13178 (comment)

I put a fix workaround into #1353 (this commit: 653dcc4) but it hasn't been merged yet

@scott-huberty
Copy link
Contributor Author

Ah I didn't realize this was already on the radar over at #1353, thx @drammock !

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

No branches or pull requests

2 participants