Skip to content

Add sphinx references to pylint messages #10563

@cdce8p

Description

@cdce8p

We frequently reference existing pylint checks in the documentation, especially for changelog entries. It would be great if those would link to the corresponding message page.

https://pylint.readthedocs.io/en/stable/whatsnew/3/3.3/index.html
https://pylint.readthedocs.io/en/stable/user_guide/messages/error/used-before-assignment.html

Ideally this would be a custom sphinx role like pylint or pylint-msg so we could reference it like this

:pylint:`used-before-assignment`

Reference

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions