Skip to content

check_crossrefs is not a valid option #43

Open
@thetianshuhuang

Description

@thetianshuhuang

check_crossrefs is not showing up as a valid configuration option, and I get an "Invalid options" error when I try to add it to the global options:

ERROR   -  Invalid options: PythonOptions.__init__() got an unexpected keyword argument 'check_crossrefs'

It looks like the config is being parsed through PythonConfig.from_data(...), which gets relative_crossrefs, but misses check_crossrefs. Maybe there needs to be a custom PythonRelXRefConfig which redirects to PythonRelXRefOptions?

Interestingly, when I try to add it to the local options, I get a different error:

dataclasses.FrozenInstanceError: cannot assign to field 'check_crossrefs'

No idea what's going on here.

I'm using mkdocstrings 0.29.0, and the latest (1.16.2) mkdocstrings-python-xref.

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