{"author":null,"author_email":"Georg Brandl , Julien Palard ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: Python Software Foundation License","Natural Language :: English","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Documentation :: Sphinx"],"description":"# Sphinx Lint\n\n[![PyPI](https://img.shields.io/pypi/v/sphinx-lint)\n ![Monthly downloads](https://img.shields.io/pypi/dm/sphinx-lint)\n ![Supported Python Version](https://img.shields.io/pypi/pyversions/sphinx-lint.svg)\n](https://pypi.org/project/sphinx-lint)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/sphinx-contrib/sphinx-lint/tests.yml?branch=main)](https://github.com/sphinx-contrib/sphinx-lint/actions)\n\nSphinx Lint is based on [rstlint.py from\nCPython](https://github.com/python/cpython/blob/e0433c1e7/Doc/tools/rstlint.py).\n\n\n## What is Sphinx Lint, what is it not?\n\nSphinx Lint should:\n\n- be reasonably fast so it's comfortable to use as a linter in your editor.\n- be usable on a single file.\n- not give any false positives (probably a utopia, but let's try).\n- not spend too much effort finding errors that sphinx-build already finds (or can easily find).\n- focus on finding errors that are **not** visible to sphinx-build.\n\n\n## Using Sphinx Lint\n\nHere are some example invocations of Sphinx Lint from the command line:\n\n```sh\nsphinx-lint # check all dirs and files\nsphinx-lint file.rst # check a single file\nsphinx-lint docs # check a directory\nsphinx-lint -i venv # ignore a file/directory\nsphinx-lint -h # for more options\n```\n\nSphinx Lint can also be used via [pre-commit](https://pre-commit.com).\nWe recommend using a configuration like this:\n\n```yaml\n - repo: https://github.com/sphinx-contrib/sphinx-lint\n rev: LATEST_SPHINXLINT_RELEASE_TAG\n hooks:\n - id: sphinx-lint\n```\n\n\n## Known issues\n\nCurrently Sphinx Lint can't work with tables, there's no understanding\nof how `linesplit` works in tables, like:\n\n```rst\n +-----------------------------------------+-----------------------------+---------------+\n | Method | Checks that | New in |\n +=========================================+=============================+===============+\n | :meth:`assertEqual(a, b) | ``a == b`` | |\n | ` | | |\n +-----------------------------------------+-----------------------------+---------------+\n```\n\nas Sphinx Lint works line by line it will inevitably think the `:meth:` role is not closed properly.\n\nTo avoid false positives, some rules are skipped if we're in a table.\n\n\n## Contributing\n\nA quick way to test if some syntax is valid from a pure\nreStructuredText point of view, one case use `docutils`'s `pseudoxml`\nwriter, like:\n\n```text\n$ docutils --writer=pseudoxml tests/fixtures/xpass/role-in-code-sample.rst\n\n \n Found in the pandas documentation, this is valid:\n \n \n \n A pandas class (in the form\n \n :class:`pandas.Series`\n )\n \n \n A pandas method (in the form\n \n :meth:`pandas.Series.sum`\n )\n \n \n A pandas function (in the form\n \n :func:`pandas.to_datetime`\n )\n \n it's documenting roles using code samples (double backticks).\n```\n\n\n## Releasing\n\n1. Make sure that the [CI tests pass](https://github.com/sphinx-contrib/sphinx-lint/actions)\n and optionally double-check locally with \"friends projects\" by running:\n\n sh download-more-tests.sh\n python -m pytest\n2. Go on the [Releases page](https://github.com/sphinx-contrib/sphinx-lint/releases)\n3. Click \"Draft a new release\"\n4. Click \"Choose a tag\"\n5. Type the next vX.Y.Z version and select \"Create new tag: vX.Y.Z on publish\"\n6. Leave the \"Release title\" blank (it will be autofilled)\n7. Click \"Generate release notes\" and amend as required\n8. Click \"Publish release\"\n9. Check the tagged\n [GitHub Actions build](https://github.com/sphinx-contrib/sphinx-lint/actions/workflows/deploy.yml)\n has [deployed to PyPI](https://pypi.org/project/sphinx-lint/#history)\n\n\n## License\n\nAs this script was in the CPython repository the license is the Python\nSoftware Foundation Licence Version 2, see the LICENSE file for a full\nversion.\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":"PSF License","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"sphinx-lint","package_url":"https://pypi.org/project/sphinx-lint/","platform":null,"project_url":"https://pypi.org/project/sphinx-lint/","project_urls":{"Changelog":"https://github.com/sphinx-contrib/sphinx-lint/releases","Repository":"https://github.com/sphinx-contrib/sphinx-lint"},"provides_extra":["tests"],"release_url":"https://pypi.org/project/sphinx-lint/1.0.0/","requires_dist":["polib","regex","pytest; extra == \"tests\"","pytest-cov; extra == \"tests\""],"requires_python":">=3.8","summary":"Check for stylistic and formal issues in .rst and .py files included in the documentation.","version":"1.0.0","yanked":false,"yanked_reason":null}

Dependencies of sphinx-lint (4).
Dependency	Optional
polib	false
regex	false
pytest	true
pytest-cov	true

Package search

sphinx-lint

project_urls

Dependencies

All package metadata

Releases