{"repo":"sphinx-contrib/sphinx-lint","free":true,"listed":false,"github":"https://github.com/sphinx-contrib/sphinx-lint","clone":"git clone https://github.com/sphinx-contrib/sphinx-lint.git","description":"Check for stylistic and formal issues in .rst and .py files included in the documentation","language":"Python","stars":104,"topics":["docs","documentation","lint","linter","python","sphinx","restructuredtext","rst"],"license":null,"category":"dev-tools","readme_excerpt":"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. Using Sphinx Lint Here are some example invocations of Sphinx Lint from the command line: Sphinx Lint can also be used via pre-commit. We recommend using a configuration like this: Selecting checks Most checks are enabled by default. The following checks are available but disabled by default: Check Description --- --- default-role Reports default roles, such as print , which many projects allow. leaked-markup Checks built HTML files for leaked reStructuredText markup. line-too-long Reports lines longer than 80 characters by default; use --max-line-length to change the limit. triple-backticks Reports triple backticks, such as , which are valid but uncommon reStructuredText. Use --enable to opt into one or more checks: In a pre-commit configuration, pass the option using args : Run sphinx-lint --list to see every available check and whether it is enabled. You can combine --list with --enable and --disable to preview the resulting selection. Known issues Currently Sphinx Lint can't work with tables, there's no understanding of how line","default_branch":null,"files":null,"tree":[],"storefront":"/r/sphinx-contrib","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/sphinx-contrib/sphinx-lint/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}