Working on sphinxlint, should it be official?

[JulienPalard]

Hi!

Context: I'm working on rstlint.py from the cpython Doc/tools/ tree [1] and for confort I'm starting to work on it in a separate repo more as a projet than a script.

(It's not really an rstlint, it's trying to accept what's acceptable in Sphinx's rst, so it probably means renaming the thing, like sphinxlint.)

The question is, now that's it's a repo, where should we host it? Obviously we could host it in the psf/ or python/ organizations, but maybe it's worth being put in the sphinx-doc org as an official tool?

[jeanas]

Interesting work! I wonder if this could be somehow integrated with Sphinx so that it will be given the list of allowable roles and directives automatically. Maybe you can make it a custom builder (https://www.sphinx-doc.org/en/master/extdev/builderapi.html#sphinx.builders.Builder)? That would also help in not re-doing the linting work on unchanged source files.

[tk0miya]

How about hosting it on https://github.com/sphinx-contrib? It is a commonly used organization for the collection of sphinx extension and related tools.

[JulienPalard]

@jean-abou-samra having it as a builder means working at a project level (which can be particularly slow in cpython), while I want it to be able to work quickly at a file level (in editors).

[jeanas]

It depends on what you call the project level -- you have to init Sphinx, but not to parse rst source files. See the attached quick proof-of-concept, to apply in the CPython repo. It still takes 0.7s to run, which may be more than you want (I'm not sure where that overhead comes from, maybe it can be cut down), but it is definitely faster than something like make linkcheck. Of course it would need some love to be turned into a method usable by sphinxlint.

lint-builder.patch.txt

[JulienPalard]

This is interesting, thanks! Worth considering.

[JulienPalard]

@tk0miya Can I have something like https://github.com/sphinx-contrib/sphinxlint?

[jeanas]

@JulienPalard As far as I understand, sphinxcontrib is not officially part of Sphinx. See https://github.com/sphinx-contrib/github-administration for how to request an addition.

[JulienPalard]

OK we have https://github.com/sphinx-contrib/sphinx-lint! Thanks!