Skip to main content

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

Project description

Sphinx Lint

PyPI Monthly downloads Supported Python Version GitHub Workflow Status

Sphinx Lint is based on rstlint.py from CPython.

What is Sphinx Lint, what is it 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 positives (probably a utopia, but let's try).
  • not spend too much effort finding errors that sphinx-build already finds (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 works 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.

Releasing

First test with friends projects by running:

sh download-more-tests.sh
python -m pytest

Bump the version in sphinxlint.py, commit, tag, push:

git tag v0.6.5
git push
git push --tags

To release on PyPI run:

python -m pip install --upgrade build twine
python -m build
python -m twine upload dist/*

License

As this script was in the CPython repository the license is the Python Software Foundation Licence Version 2, see the 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.6.6.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

sphinx_lint-0.6.6-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-lint-0.6.6.tar.gz.

File metadata

  • Download URL: sphinx-lint-0.6.6.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for sphinx-lint-0.6.6.tar.gz
Algorithm Hash digest
SHA256 a3654bd502079b83f9c907aa61abdd278d0fe48ffbfe2008bb8b23b5677d4bc3
MD5 80c3bd8ad11014659810d0dc206ea5e4
BLAKE2b-256 8ceafd4692ee88081664331b29dbb62e9770f2e5a83037df7125b4a9b786dbcb

See more details on using hashes here.

Provenance

File details

Details for the file sphinx_lint-0.6.6-py3-none-any.whl.

File metadata

  • Download URL: sphinx_lint-0.6.6-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for sphinx_lint-0.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b6bf6031880d033036891db847898725e1cd3ec9e44d51b72c140b8d77e5924e
MD5 c55de48465781cdff18d50786746cd7a
BLAKE2b-256 7acf8fe00363d81067e98d9316814ea98f9f2a7029d268322f751f5b199fa398

See more details on using hashes here.

Provenance

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