{"library":"sphinx-lint","title":"Sphinx Lint","type":"library","description":"Sphinx Lint is a lightweight Python linter designed to check for stylistic and formal issues in `.rst` (reStructuredText) and `.py` (Python) files primarily used in Sphinx documentation. It complements other linters by focusing on Sphinx-specific field list conventions and semantic consistency checks. The current version is 1.0.2, and the library maintains an active release cadence with regular updates and improvements.","language":"python","status":"active","last_verified":"Mon Apr 13","install":{"commands":["pip install sphinx-lint"],"cli":{"name":"sphinx-lint","version":"sphinx-lint 1.0.2"}},"imports":[],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/sphinx-contrib/sphinx-lint","docs":null,"changelog":"https://github.com/sphinx-contrib/sphinx-lint/releases","pypi":"https://pypi.org/project/sphinx-lint/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"pip install sphinx-lint pre-commit\npre-commit install\n\n# .pre-commit-config.yaml example\n# In your project's root:\n# git init\n# pre-commit install\n# vim .pre-commit-config.yaml\n# Add the following content:\n#\n# repos:\n#   - repo: https://github.com/sphinx-contrib/sphinx-lint\n#     rev: v1.0.2 # Use the latest release tag\n#     hooks:\n#       - id: sphinx-lint\n#         types: [rst, python]\n\n# Command line usage\nsphinx-lint\n# Check a specific file\nsphinx-lint docs/index.rst\n# Check a directory\nsphinx-lint docs\n# Ignore a directory\nsphinx-lint -i venv\n# Show help\nsphinx-lint -h","lang":"bash","description":"Sphinx Lint is primarily used as a command-line tool or integrated with pre-commit hooks. The most common setup involves adding it to your project's `.pre-commit-config.yaml` to ensure documentation quality before commits. For direct command-line usage, simply run `sphinx-lint` with paths to files or directories.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}