{"id":13795227,"url":"https://github.com/rstcheck/rstcheck","last_synced_at":"2025-12-11T23:02:22.050Z","repository":{"id":12239751,"uuid":"14851887","full_name":"rstcheck/rstcheck","owner":"rstcheck","description":"Checks syntax of reStructuredText and code blocks nested within it","archived":false,"fork":false,"pushed_at":"2025-12-08T21:43:36.000Z","size":953,"stargazers_count":248,"open_issues_count":7,"forks_count":42,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-12-11T16:20:10.670Z","etag":null,"topics":["linter","python","restructuredtext","static-analysis"],"latest_commit_sha":null,"homepage":"http://rstcheck.rtfd.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rstcheck.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2013-12-02T03:29:16.000Z","updated_at":"2025-12-10T02:21:17.000Z","dependencies_parsed_at":"2023-10-23T22:22:45.556Z","dependency_job_id":"30b9c1ba-5123-4292-a88f-3055e3c4d95a","html_url":"https://github.com/rstcheck/rstcheck","commit_stats":{"total_commits":1020,"total_committers":27,"mean_commits":37.77777777777778,"dds":0.4441176470588235,"last_synced_commit":"178e8c1001aebe2dcbf006e7e6980246704d2315"},"previous_names":["myint/rstcheck"],"tags_count":57,"template":false,"template_full_name":null,"purl":"pkg:github/rstcheck/rstcheck","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstcheck%2Frstcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstcheck%2Frstcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstcheck%2Frstcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstcheck%2Frstcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rstcheck","download_url":"https://codeload.github.com/rstcheck/rstcheck/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstcheck%2Frstcheck/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27670281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-11T02:00:11.302Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linter","python","restructuredtext","static-analysis"],"created_at":"2024-08-03T23:00:53.479Z","updated_at":"2025-12-11T23:02:21.720Z","avatar_url":"https://github.com/rstcheck.png","language":"Python","funding_links":[],"categories":["Tool Collection"],"sub_categories":["Search"],"readme":"========\nrstcheck\n========\n\n+-------------------+---------------------------------------------------------------------------------------------+\n| **General**       | |maintenance_y| |license| |semver|                                                          |\n|                   +---------------------------------------------------------------------------------------------+\n|                   | |rtd|                                                                                       |\n+-------------------+---------------------------------------------------------------------------------------------+\n| **CI**            | |gha_tests| |gha_docu| |gha_qa| |pre_commit_ci|                                             |\n+-------------------+---------------------------------------------------------------------------------------------+\n| **PyPI**          | |pypi_release| |pypi_py_versions| |pypi_implementations|                                    |\n|                   +---------------------------------------------------------------------------------------------+\n|                   | |pypi_format| |pypi_downloads|                                                              |\n+-------------------+---------------------------------------------------------------------------------------------+\n| **Github**        | |gh_tag| |gh_last_commit|                                                                   |\n|                   +---------------------------------------------------------------------------------------------+\n|                   | |gh_stars| |gh_forks| |gh_contributors| |gh_watchers|                                       |\n+-------------------+---------------------------------------------------------------------------------------------+\n\n\nChecks syntax of reStructuredText and code blocks nested within it.\n\nSee the full documentation at `read-the-docs`_\n\n\n.. contents::\n\n\nInstallation\n============\n\nFrom pip\n\n.. code:: shell\n\n    $ pip install rstcheck\n\nTo use pyproject.toml for configuration::\n\n    $ pip install rstcheck[toml]\n\nTo add sphinx support::\n\n    $ pip install rstcheck[sphinx]\n\nPre-commit Hook with Extras\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo use ``rstcheck`` in a Git pre-commit hook with optional features:\n\n1. Install pre-commit::\n\n     pip install pre-commit\n\n2. Add to ``.pre-commit-config.yaml``::\n\n     - repo: https://github.com/rstcheck/rstcheck\n       rev: main # should be replaced with the current verison\n       hooks:\n         - id: rstcheck\n           additional_dependencies: ['rstcheck[sphinx,toml]']\n\n3. Run ``pre-commit install`` to activate.\n\n\n\nSupported languages in code blocks\n==================================\n\n- Bash\n- Doctest\n- C (C99)\n- C++ (C++11)\n- JSON\n- XML\n- Python\n- reStructuredText\n\n\nExamples\n========\n\n.. rstcheck: ignore-languages=cpp,python,rst\n\nWith bad Python syntax:\n\n.. code:: rst\n\n    ====\n    Test\n    ====\n\n    .. code:: python\n\n        print(\n\n.. code:: text\n\n    $ rstcheck bad_python.rst\n    bad_python.rst:7: (ERROR/3) (python) unexpected EOF while parsing\n\nWith bad C++ syntax:\n\n.. code:: rst\n\n    ====\n    Test\n    ====\n\n    .. code:: cpp\n\n        int main()\n        {\n            return x;\n        }\n\n.. code:: text\n\n    $ rstcheck bad_cpp.rst\n    bad_cpp.rst:9: (ERROR/3) (cpp) error: 'x' was not declared in this scope\n\nWith bad syntax in the reStructuredText document itself:\n\n.. code:: rst\n\n    ====\n    Test\n    ===\n\n.. code:: text\n\n    $ rstcheck bad_rst.rst\n    bad_rst.rst:1: (SEVERE/4) Title overline \u0026 underline mismatch.\n\n\n.. _read-the-docs: https://rstcheck.readthedocs.io\n\n\n.. General\n\n.. |maintenance_n| image:: https://img.shields.io/badge/Maintenance%20Intended-✖-red.svg?style=flat-square\n    :target: http://unmaintained.tech/\n    :alt: Maintenance - not intended\n\n.. |maintenance_y| image:: https://img.shields.io/badge/Maintenance%20Intended-✔-green.svg?style=flat-square\n    :target: http://unmaintained.tech/\n    :alt: Maintenance - intended\n\n.. |license| image:: https://img.shields.io/github/license/rstcheck/rstcheck.svg?style=flat-square\u0026label=License\n    :target: https://github.com/rstcheck/rstcheck/blob/main/LICENSE\n    :alt: License\n\n.. |semver| image:: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square\n    :target: https://semver.org/\n    :alt: Semantic Versioning - 2.0.0\n\n.. |rtd| image:: https://img.shields.io/readthedocs/rstcheck/latest.svg?style=flat-square\u0026logo=read-the-docs\u0026logoColor=white\u0026label=Read%20the%20Docs\n    :target: https://rstcheck.readthedocs.io/en/latest/\n    :alt: Read the Docs - Build Status (latest)\n\n\n.. CI\n\n.. |gha_tests| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck/test.yml?branch=main\u0026style=flat-square\u0026logo=github\u0026label=Test%20code\n    :target: https://github.com/rstcheck/rstcheck/actions/workflows/test.yaml\n    :alt: Test status\n\n.. |gha_docu| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck/documentation.yml?branch=main\u0026style=flat-square\u0026logo=github\u0026label=Test%20documentation\n    :target: https://github.com/rstcheck/rstcheck/actions/workflows/documentation.yaml\n    :alt: Documentation status\n\n.. |gha_qa| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck/qa.yml?branch=main\u0026style=flat-square\u0026logo=github\u0026label=QA\n    :target: https://github.com/rstcheck/rstcheck/actions/workflows/qa.yaml\n    :alt: QA status\n\n.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/rstcheck/rstcheck/main.svg\n    :target: https://results.pre-commit.ci/latest/github/rstcheck/rstcheck/main\n    :alt: pre-commit status\n\n\n.. PyPI\n\n.. |pypi_release| image:: https://img.shields.io/pypi/v/rstcheck.svg?style=flat-square\u0026logo=pypi\u0026logoColor=FBE072\n    :target: https://pypi.org/project/rstcheck/\n    :alt: PyPI - Package latest release\n\n.. |pypi_py_versions| image:: https://img.shields.io/pypi/pyversions/rstcheck.svg?style=flat-square\u0026logo=python\u0026logoColor=FBE072\n    :target: https://pypi.org/project/rstcheck/\n    :alt: PyPI - Supported Python Versions\n\n.. |pypi_implementations| image:: https://img.shields.io/pypi/implementation/rstcheck.svg?style=flat-square\u0026logo=python\u0026logoColor=FBE072\n    :target: https://pypi.org/project/rstcheck/\n    :alt: PyPI - Supported Implementations\n\n.. |pypi_format| image:: https://img.shields.io/pypi/format/rstcheck.svg?style=flat-square\u0026logo=pypi\u0026logoColor=FBE072\n    :target: https://pypi.org/project/rstcheck/\n    :alt: PyPI - Format\n\n.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/rstcheck.svg?style=flat-square\u0026logo=pypi\u0026logoColor=FBE072\n    :target: https://pypi.org/project/rstcheck/\n    :alt: PyPI - Monthly downloads\n\n\n\n.. GitHub\n\n.. |gh_tag| image:: https://img.shields.io/github/v/tag/rstcheck/rstcheck.svg?sort=semver\u0026style=flat-square\u0026logo=github\n    :target: https://github.com/rstcheck/rstcheck/tags\n    :alt: Github - Latest Release\n\n.. |gh_last_commit| image:: https://img.shields.io/github/last-commit/rstcheck/rstcheck.svg?style=flat-square\u0026logo=github\n    :target: https://github.com/rstcheck/rstcheck/commits/main\n    :alt: GitHub - Last Commit\n\n.. |gh_stars| image:: https://img.shields.io/github/stars/rstcheck/rstcheck.svg?style=flat-square\u0026logo=github\n    :target: https://github.com/rstcheck/rstcheck/stargazers\n    :alt: Github - Stars\n\n.. |gh_forks| image:: https://img.shields.io/github/forks/rstcheck/rstcheck.svg?style=flat-square\u0026logo=github\n    :target: https://github.com/rstcheck/rstcheck/network/members\n    :alt: Github - Forks\n\n.. |gh_contributors| image:: https://img.shields.io/github/contributors/rstcheck/rstcheck.svg?style=flat-square\u0026logo=github\n    :target: https://github.com/rstcheck/rstcheck/graphs/contributors\n    :alt: Github - Contributors\n\n.. |gh_watchers| image:: https://img.shields.io/github/watchers/rstcheck/rstcheck.svg?style=flat-square\u0026logo=github\n    :target: https://github.com/rstcheck/rstcheck/watchers/\n    :alt: Github - Watchers\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frstcheck%2Frstcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frstcheck%2Frstcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frstcheck%2Frstcheck/lists"}