Skip to main content

Check for stylistic and formal issues in .rst and .py files included in the documentation.

Project description

Sphinx Lint

Sphinx Lint is based on rstlint.py from cpython.

What sphinx-lint is, what it is not?

sphinx-lint should:

  • be reasonably fast so it's comfortable to use as a linter in your editor.
  • be usable on a single file.
  • not give any false positive (probably an utopy, but let's try).
  • not spend too much efforts finding errors that sphinx-build already find (or can easily find).
  • focus on finding errors that are not visible to sphinx-build.

Known issues

Currently sphinx-lint can't work with tables, there's no understanding of how linesplit work in tables, like:

   +-----------------------------------------+-----------------------------+---------------+
   | Method                                  | Checks that                 | New in        |
   +=========================================+=============================+===============+
   | :meth:`assertEqual(a, b)                | ``a == b``                  |               |
   | <TestCase.assertEqual>`                 |                             |               |
   +-----------------------------------------+-----------------------------+---------------+

as sphinx-lint works line by line it will inevitably think the :meth: role is not closed properly.

To avoid false positives, some rules are skipped if we're in a table.

License

As this script was in the cpython repository the license is the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2, see LICENSE file for a full version.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-lint-0.1.tar.gz (9.2 kB view hashes)

Uploaded Source

Built Distribution

sphinx_lint-0.1-py3-none-any.whl (9.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page