doc8

{
  "aliases": [],
  "alternatives": [],
  "build_dependencies": [],
  "categories": [],
  "caveats": null,
  "conflicts_with": [],
  "dependencies": [
    "python@3.14"
  ],
  "deprecated": 0,
  "deprecation_reason": null,
  "desc": "Style checker for Sphinx documentation",
  "disable_reason": null,
  "disabled": 0,
  "enrichment_fetched_at": "2026-06-20T23:37:01+00:00",
  "first_seen": "2026-06-20T23:34:18+00:00",
  "full_name": "doc8",
  "github_default_branch": "main",
  "github_last_commit_at": "2026-06-15T22:21:15Z",
  "github_readme_excerpt": ".. image:: https://img.shields.io/pypi/v/doc8?logo=python\u0026logoColor=white\n   :target: https://pypi.org/project/doc8/\n   :alt: PyPI\n\n.. image:: https://img.shields.io/github/actions/workflow/status/PyCQA/doc8/tox.yml?label=tox\u0026logo=github\u0026logoColor=white\n   :target: https://github.com/PyCQA/doc8/actions\n   :alt: CI\n\n.. image:: https://img.shields.io/pypi/l/doc8\n   :target: https://github.com/PyCQA/doc8/blob/main/LICENSE\n   :alt: PyPI - License\n\n.. image:: https://img.shields.io/github/last-commit/pycqa/doc8\n   :target: https://github.com/PyCQA/doc8/commits/main\n   :alt: GitHub last commit\n\n.. image:: https://img.shields.io/readthedocs/doc8/stable?logo=readthedocs\u0026logoColor=white\n   :target: https://doc8.readthedocs.io/en/stable/index.html\n   :alt: Read the Docs (stable)\n\n====\ndoc8\n====\n\n*doc8* is an *opinionated* style checker for rst__ (with basic support for\nplain text) styles of documentation.\n\n__ http://docutils.sourceforge.net/docs/ref/rst/introduction.html\n\nQuick start\n-----------\n\n::\n\n    pip install doc8\n\nTo run *doc8*, just invoke it against any documentation directory::\n\n    $ doc8 cool-project/docs\n\nUsage\n-----\n\n::\n\n    $ doc8  -h\n\n    usage: doc8 [-h] [--config path] [--allow-long-titles] [--ignore code]\n                [--no-sphinx] [--ignore-path path] [--ignore-path-errors path]\n                [--default-extension extension] [--file-encoding encoding]\n                [--max-line-length int] [-e extension] [-v] [--version]\n                [path [path ...]]\n\n    Check documentation for simple style requirements.\n\n    What is checked:\n        - invalid RST format - D000\n        - lines should not be longer than 79 characters - D001\n          - RST exception: line with no whitespace except in the beginning\n          - RST exception: lines with http or https urls\n          - RST exception: literal blocks\n          - RST exception: rst target directives\n        - no trailing whitespace - D002\n        - no tabulation for indentation - D003\n        - no carri",
  "github_repo": "PyCQA/doc8",
  "github_stars": 176,
  "github_topics": [
    "hacktoberfest",
    "linter",
    "pep-621",
    "pre-commit-hook",
    "python"
  ],
  "homepage": "https://github.com/PyCQA/doc8",
  "homepage_og_description": null,
  "homepage_og_image": null,
  "homepage_title": null,
  "installs_30d": 10,
  "installs_365d": 213,
  "installs_90d": 56,
  "keg_only": 0,
  "keg_only_reason": null,
  "last_seen": "2026-06-20T23:34:18+00:00",
  "license": "Apache-2.0",
  "llm_generated_at": null,
  "llm_model": null,
  "name": "doc8",
  "oldnames": [],
  "one_liner": null,
  "optional_dependencies": [],
  "rank_30d": 8719,
  "rank_365d": 7206,
  "rank_90d": 7039,
  "raw_hash": "afcfaaa44b9daa46",
  "recommended_dependencies": [],
  "revision": 1,
  "ruby_source_path": "Formula/d/doc8.rb",
  "tap": "homebrew/core",
  "test_dependencies": [],
  "uses_from_macos": [],
  "version_head": "HEAD",
  "version_stable": "2.0.0",
  "versioned_formulae": [],
  "why_use_this": null
}