Add sphinx documentation style to pydocstyle config

[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.

[charliermarsh]

We can probably add a convention that's compatible, but there would also be necessary work to actually support parsing Sphinx docstrings (e.g., PyCQA/pydocstyle#595). pydocstyle itself does not support this.

[Eutropios]

Alright, so as far as I know, the necessary pull requests to pydocstyle have been made as of 5 hours ago. Relevant commit here: PyCQA/pydocstyle/commit.

[LecrisUT]

Related, it would be nice to get a check when a different convention is used.

[charliermarsh]

(Removing needs-decision since we should support this now.)

[Eutropios]

Sounds great! Let me know if there's anything I can do to help.

[winwinashwin]

+1 on this feature. Any updates on sphinx support?

[DanPaseltiner]

Ditto @winwinashwin. We would adopt Ruff immediately on this project it there was sphinx support. Unfortunately, we have a code base full of Sphinx style docstrings and need to implement linting on them.

[jaladh-singhal]

Hi, just checking if/when this will be available?

BTW thanks for making this super awesome tool!

[Lassii-]

Hello,

Also wondering if there's any plan updates to this? The project I work for is also looking for the support.

[seppzer0]

@charliermarsh , @zanieb , hi! Sorry for pinging directly on this, I see this as an only option to revive this ticket.

I noticed that this was going to be supported, but there haven't been news for a while. Could you please inform whether this is going to be supported in ruff?

Looking forward to bundle this with uv usage to have a fully configured ecosystem for our projects.

[seppzer0]

I think I found related PRs, as far as I understand they are still under review

• [pydoclint] Add support for Sphinx-style docstrings in the pydoclint rules. #13286
• [pydoclint] Add docstring-missing-parameter and docstring-extraneous-parameter (DOC101, DOC102) #13280

[MichaReiser]

@seppzer0 I understand that this feature is important to you but please stop pinging people. We get a lot of notifications every day and pinging only results in additional distractions, meaning we have less time to do actual feature work.

We plan to look at linked PRs but it might take a while because we have to balance it with other features that we want to ship. We'll make sure to update this issue or the linked PRs if there's an update.

[seppzer0]

@MichaReiser , thank you for your response! I do understand that pinging people is not great, unfortunately though it is often the only way to remind of the topic at hand.

Thank you once again for your work! Looking towards to this great feature 👍🏻