sphinx-lint

sphinx-lint copied to clipboard

As mentionned in https://github.com/python/python-docs-es/issues/2200#issuecomment-1320770780: ``` some words *with stars*``backtick-words`` ``` is detected as valid by sphinx-lint, while it is not: ``` $ rst2pseudoxml tests/fixtures/xfail/inline-literal-glued-to-emphasis.rst tests/fixtures/xfail/inline-literal-glued-to-emphasis.rst:1: (WARNING/2) Inline emphasis start-string without...

JulienPalard

Check for missing underscores in references

9

Here are the two reST traps that I find most nasty: ``` `Missing underscore after hyperlink ` .. missing-underscore-before-target-name: Section ======= ``` Relatedly, there could be a check for the...

jeanas

Detecting missing newline before lists

2

This may be at risk of false positives, but it would be great if sphinx-lint could warn for missing newlines before lists. That is something that I personally tend to...

oscargus

See https://github.com/python/cpython/pull/94120/files ``` There were a number of other small changes to the C-API. See the Misc/NEWS `_ file for a complete list. ``` passed successfully ☹

JulienPalard

check_missing_space_after_literal false positive

2

see: https://github.com/sphinx-doc/sphinx/pull/10389#issuecomment-1158000799=

JulienPalard

Plural glued to inline literal not detected

2

See: https://github.com/python/cpython/pull/32331

JulienPalard

Detect invalid role targets

3

Currently it's possible to refer to functions, methods, classes, etc. that don't exist, using `` :func:`not_existing_function()` ``. This is sometimes done intentionally, but other times the target is invalid because...

ezio-melotti

Configure supported directives

1

A brief look through the source, I saw the list of directive names is hardcoded and contains many specific to the CPython docs: https://github.com/sphinx-contrib/sphinx-lint/blob/f6a736db170cc9b4eef14f0708c4bc01e7b81dd7/sphinxlint.py#L87-L100 Would it be an idea to...

AA-Turner

Section headers

2

reST requires section headers to be at least as long as the title. This is invalid: ``` Section title ============ ``` Also, overline and underline must also be the same...

jeanas

Here's one mistake found in Pygments: ``` .. versionadded::0.1 ``` Due to the missing space before `0.1`, the whole thing is taken as a comment and ignored. (Wow, the more...

jeanas