sphinx-lint

sphinx-lint copied to clipboard

Add tox.

1

JulienPalard

When used together with pre-commit inspired by Black or Ruff, it would be great if this lint doe example could carry some safe/trivial fixes: - `trailing whitespace` - `No newline...

Borda

Detect typo :mod:`!cgi``

4

Oh, I'm surprising that sphinx-lint missing this typo in my PR https://github.com/python/cpython/pull/104775 : ``` * :pep:`594`: Remove the :mod:`!cgi`` and :mod:`!cgitb` modules, deprecated in Python 3.11. ``` It should be:...

vstinner

Fixes https://github.com/sphinx-contrib/sphinx-lint/issues/108. Add the "cross-referencing C constructs" from: https://www.sphinx-doc.org/en/master/usage/domains/c.html#cross-referencing-c-constructs The 3.13/Ubuntu job fails as expected, because it also checks the friend projects, and finds the two CPython examples mentioned in...

hugovk

Default role not found in indented block

2

Given this (based on https://github.com/python/cpython/blob/9f088336b268dfe9011a7cb550f4e488ccd7e8f5/Doc/library/code.rst?plain=1): ```rst .. c:type:: int (*PyCode_WatchCallback)(PyCodeEvent event, PyCodeObject* co) Not detected: If *event* is ``PY_CODE_EVENT_CREATE``, then the callback is invoked after `co` has been fully initialized....

hugovk

[question] Problem matcher for sphinx-lint ?

5

Is there a problem matcher for sphinx-lint's output? I tried [sphinx-doc/github-problem-matcher](https://github.com/sphinx-doc/github-problem-matcher) but it seems to be designed for Sphinx output.

rffontenelle

Previously `Tous les *\*args* et *\*\*kwargs* fournis à cette fonction sont` was cleaned as `Tous les et kwargs* fournis à cette fonction sont` because `*\*\*` at the beginning of `*\*\*kwargs*`...

JulienPalard

Check for underscores used instead of stars for emphasis

1

While Markdown allows both `_emphasis_` and `*emphasis*`, reST only has `*emphasis*`. On this page of the packaging user guide, someone apparently thought underscores would work: https://packaging.python.org/en/latest/specifications/name-normalization/ > `FrIeNdLy-._.-bArD` (a \_terrible\_...

jeanas

Breaking changes to custom checkers

6

I've been using sphinx-lint for a while to lint documentation for projects with many contributors, and I have a custom `@checker` decorated function to check header levels. Is it not...

vkbo

This draft PR adds a checker for excessive indentation, as discussed in #75.

ezio-melotti