Skip to content

Documentation Build Errors. #1358

@scott-huberty

Description

@scott-huberty

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions