Feature request: sphinx

[jsh9]

Feature request: sphinx

[jsh9]

Thanks!

pydoclint uses docstring-parser to parse Google-style docstrings, and I know it can also parse Sphinx-style docstrings:

pydoclint/setup.cfg

Line 21 in 062bb45

docstring_parser>=0.15

The reason I'm asking for a style guide is for me to write test cases. I haven't really used the Sphinx style before.

[jsh9]

Hi @wwuck:

I added support for the Sphinx docstring style. It's in the latest release (v0.1.0).

Please feel free to try it out. Since I'm not very familiar with this style, I don't know what different variations of this style can there be.

If you find any issues or false positives, please feel free to open other issues. Thanks!

[jsh9]

I procrastinated a bit but this day has eventually come 😂

Yes, this is something that I could add.

Could you confirm that this is the official guide/rules of the Sphinx docstring style? https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

Thanks!

[wwuck]

I believe the docs would be at https://www.sphinx-doc.org/, specifically https://www.sphinx-doc.org/en/master/tutorial/describing-code.html#documenting-python-objects.

[wwuck]

The darglint2 readme mentions a couple of libraries that claim to parse sphinx docstring format:

https://pypi.org/project/docstring-utils/
https://pypi.org/project/docstring-parser/

[wwuck]

I guess the link you found above looks ok for examples. I also found some bnf grammar definitions in darglint repository that may be useful: https://github.com/akaihola/darglint2/tree/master/darglint2/parse/grammars