sphinx-lint icon indicating copy to clipboard operation
sphinx-lint copied to clipboard

Linting Python docstrings for valid rst

Open PicoCentauri opened this issue 4 months ago • 3 comments
trafficstars

Hi, First of all, thank you for this great project — we’ve been using sphinx-lint in several projects and it has helped us maintain high-quality rst pages consistently.

One thing I’d love to do is also check the reStructuredText syntax inside Python docstrings, as they often contain just as much (if not more) documentation than the standalone .rst files.

Is there currently a way to lint docstrings directly with sphinx-lint? If not, would support for this be within the scope of the project?

Thanks again for your work!

PicoCentauri avatar Jul 20 '25 19:07 PicoCentauri