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 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
One should use the populate-xpass.sh script before running tests
before releasing, to avoid creating a release introducing false
positives.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx-lint-0.4.1.tar.gz.
File metadata
- Download URL: sphinx-lint-0.4.1.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 08cc0ca384716124695464a1a3357a56011236dc6ec665cb568859c514d1e1c2 |
|
| MD5 | 371e9f451111f8cb30307652e97e889b |
|
| BLAKE2b-256 | 37756823d7757bdd3f564faae910bbd6aa9d2ec3e1221508696d9339c2d710f5 |
Provenance
File details
Details for the file sphinx_lint-0.4.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_lint-0.4.1-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2dafa50fe5902b4857057cb74f238e82aa1444b3f3845cc9598e92c1ea7daad5 |
|
| MD5 | 918060198c996008c58247e4a9b12e35 |
|
| BLAKE2b-256 | 33b151031960c1c859f3da455a9c718ad4661049299fb9845da44f85d19bb93c |
