Skip to content

Add sphinx documentation style to pydocstyle config #6606

@Eutropios

Description

@Eutropios

Addition of sphinx documentation style to pydocstyle config as so:

[tool.ruff.pydocstyle]
    convention = "sphinx"

Currently pep257, google, and numpy documentation styles are supported. It'd be nice to have this major documentation style added as well.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docstringRelated to docstring linting or formatting

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions