| Name | rstcheck JSON |
| Version |
6.2.1
JSON |
| download |
| home_page | None |
| Summary | Checks syntax of reStructuredText and code blocks nested within it |
| upload_time | 2024-03-23 09:31:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
restructuredtext
rst
linter
static-analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
========
rstcheck
========
+-------------------+---------------------------------------------------------------------------------------------+
| **General** | |maintenance_y| |license| |semver| |
| +---------------------------------------------------------------------------------------------+
| | |rtd| |
+-------------------+---------------------------------------------------------------------------------------------+
| **CI** | |gha_tests| |gha_docu| |gha_qa| |pre_commit_ci| |
+-------------------+---------------------------------------------------------------------------------------------+
| **PyPI** | |pypi_release| |pypi_py_versions| |pypi_implementations| |
| +---------------------------------------------------------------------------------------------+
| | |pypi_format| |pypi_downloads| |
+-------------------+---------------------------------------------------------------------------------------------+
| **Github** | |gh_tag| |gh_last_commit| |
| +---------------------------------------------------------------------------------------------+
| | |gh_stars| |gh_forks| |gh_contributors| |gh_watchers| |
+-------------------+---------------------------------------------------------------------------------------------+
Checks syntax of reStructuredText and code blocks nested within it.
See the full documentation at `read-the-docs`_
.. contents::
Installation
============
From pip
.. code:: shell
$ pip install rstcheck
To use pyproject.toml for configuration::
$ pip install rstcheck[toml]
To add sphinx support::
$ pip install rstcheck[sphinx]
Supported languages in code blocks
==================================
- Bash
- Doctest
- C (C99)
- C++ (C++11)
- JSON
- XML
- Python
- reStructuredText
Examples
========
.. rstcheck: ignore-languages=cpp,python,rst
With bad Python syntax:
.. code:: rst
====
Test
====
.. code:: python
print(
.. code:: text
$ rstcheck bad_python.rst
bad_python.rst:7: (ERROR/3) (python) unexpected EOF while parsing
With bad C++ syntax:
.. code:: rst
====
Test
====
.. code:: cpp
int main()
{
return x;
}
.. code:: text
$ rstcheck bad_cpp.rst
bad_cpp.rst:9: (ERROR/3) (cpp) error: 'x' was not declared in this scope
With bad syntax in the reStructuredText document itself:
.. code:: rst
====
Test
===
.. code:: text
$ rstcheck bad_rst.rst
bad_rst.rst:1: (SEVERE/4) Title overline & underline mismatch.
.. _read-the-docs: https://rstcheck.readthedocs.io
.. General
.. |maintenance_n| image:: https://img.shields.io/badge/Maintenance%20Intended-✖-red.svg?style=flat-square
:target: http://unmaintained.tech/
:alt: Maintenance - not intended
.. |maintenance_y| image:: https://img.shields.io/badge/Maintenance%20Intended-✔-green.svg?style=flat-square
:target: http://unmaintained.tech/
:alt: Maintenance - intended
.. |license| image:: https://img.shields.io/github/license/rstcheck/rstcheck.svg?style=flat-square&label=License
:target: https://github.com/rstcheck/rstcheck/blob/main/LICENSE
:alt: License
.. |semver| image:: https://img.shields.io/badge/Semantic%20Versioning-2.0.0-brightgreen.svg?style=flat-square
:target: https://semver.org/
:alt: Semantic Versioning - 2.0.0
.. |rtd| image:: https://img.shields.io/readthedocs/rstcheck/latest.svg?style=flat-square&logo=read-the-docs&logoColor=white&label=Read%20the%20Docs
:target: https://rstcheck.readthedocs.io/en/latest/
:alt: Read the Docs - Build Status (latest)
.. CI
.. |gha_tests| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck/test.yml?branch=main&style=flat-square&logo=github&label=Test%20code
:target: https://github.com/rstcheck/rstcheck/actions/workflows/test.yaml
:alt: Test status
.. |gha_docu| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck/documentation.yml?branch=main&style=flat-square&logo=github&label=Test%20documentation
:target: https://github.com/rstcheck/rstcheck/actions/workflows/documentation.yaml
:alt: Documentation status
.. |gha_qa| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck/qa.yml?branch=main&style=flat-square&logo=github&label=QA
:target: https://github.com/rstcheck/rstcheck/actions/workflows/qa.yaml
:alt: QA status
.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/rstcheck/rstcheck/main.svg
:target: https://results.pre-commit.ci/latest/github/rstcheck/rstcheck/main
:alt: pre-commit status
.. PyPI
.. |pypi_release| image:: https://img.shields.io/pypi/v/rstcheck.svg?style=flat-square&logo=pypi&logoColor=FBE072
:target: https://pypi.org/project/rstcheck/
:alt: PyPI - Package latest release
.. |pypi_py_versions| image:: https://img.shields.io/pypi/pyversions/rstcheck.svg?style=flat-square&logo=python&logoColor=FBE072
:target: https://pypi.org/project/rstcheck/
:alt: PyPI - Supported Python Versions
.. |pypi_implementations| image:: https://img.shields.io/pypi/implementation/rstcheck.svg?style=flat-square&logo=python&logoColor=FBE072
:target: https://pypi.org/project/rstcheck/
:alt: PyPI - Supported Implementations
.. |pypi_format| image:: https://img.shields.io/pypi/format/rstcheck.svg?style=flat-square&logo=pypi&logoColor=FBE072
:target: https://pypi.org/project/rstcheck/
:alt: PyPI - Format
.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/rstcheck.svg?style=flat-square&logo=pypi&logoColor=FBE072
:target: https://pypi.org/project/rstcheck/
:alt: PyPI - Monthly downloads
.. GitHub
.. |gh_tag| image:: https://img.shields.io/github/v/tag/rstcheck/rstcheck.svg?sort=semver&style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck/tags
:alt: Github - Latest Release
.. |gh_last_commit| image:: https://img.shields.io/github/last-commit/rstcheck/rstcheck.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck/commits/main
:alt: GitHub - Last Commit
.. |gh_stars| image:: https://img.shields.io/github/stars/rstcheck/rstcheck.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck/stargazers
:alt: Github - Stars
.. |gh_forks| image:: https://img.shields.io/github/forks/rstcheck/rstcheck.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck/network/members
:alt: Github - Forks
.. |gh_contributors| image:: https://img.shields.io/github/contributors/rstcheck/rstcheck.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck/graphs/contributors
:alt: Github - Contributors
.. |gh_watchers| image:: https://img.shields.io/github/watchers/rstcheck/rstcheck.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck/watchers/
:alt: Github - Watchers
Raw data
{
"_id": null,
"home_page": null,
"name": "rstcheck",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Christian Riedel <cielquan@protonmail.com>",
"keywords": "restructuredtext, rst, linter, static-analysis",
"author": null,
"author_email": "Steven Myint <git@stevenmyint.com>",
"download_url": "https://files.pythonhosted.org/packages/4d/c1/ebec613b5e9225a9f5655bc17ce07b0e27e5a8fb302a1c088be5567d9f6f/rstcheck-6.2.1.tar.gz",
"platform": null,
"description": "========\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\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 & 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-\u2716-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-\u2714-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&label=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&logo=read-the-docs&logoColor=white&label=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&style=flat-square&logo=github&label=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&style=flat-square&logo=github&label=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&style=flat-square&logo=github&label=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&logo=pypi&logoColor=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&logo=python&logoColor=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&logo=python&logoColor=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&logo=pypi&logoColor=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&logo=pypi&logoColor=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&style=flat-square&logo=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&logo=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&logo=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&logo=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&logo=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&logo=github\n :target: https://github.com/rstcheck/rstcheck/watchers/\n :alt: Github - Watchers\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Checks syntax of reStructuredText and code blocks nested within it",
"version": "6.2.1",
"project_urls": {
"Changelog": "https://github.com/rstcheck/rstcheck/blob/main/CHANGELOG.md",
"Documentation": "https://rstcheck.readthedocs.io/en/latest/",
"Repository": "https://github.com/rstcheck/rstcheck"
},
"split_keywords": [
"restructuredtext",
" rst",
" linter",
" static-analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0b35556afc6e83b162dc29f84e0c8a10f6a72af70845552698acd6bb3b927cd",
"md5": "1faf2df069bf8255e14c86a4e000835d",
"sha256": "b450943707d8ca053f5c6b9f103ee595f4926a064203e5e579172aefb3fe2c12"
},
"downloads": -1,
"filename": "rstcheck-6.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1faf2df069bf8255e14c86a4e000835d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8526,
"upload_time": "2024-03-23T09:31:40",
"upload_time_iso_8601": "2024-03-23T09:31:40.716260Z",
"url": "https://files.pythonhosted.org/packages/b0/b3/5556afc6e83b162dc29f84e0c8a10f6a72af70845552698acd6bb3b927cd/rstcheck-6.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4dc1ebec613b5e9225a9f5655bc17ce07b0e27e5a8fb302a1c088be5567d9f6f",
"md5": "342d46a28e82574f1302d11f4e374aab",
"sha256": "e4d173950b023eb12c2b9d2348a8c62bef46612bbc7b29e1e57d37320ed0a891"
},
"downloads": -1,
"filename": "rstcheck-6.2.1.tar.gz",
"has_sig": false,
"md5_digest": "342d46a28e82574f1302d11f4e374aab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 23609,
"upload_time": "2024-03-23T09:31:42",
"upload_time_iso_8601": "2024-03-23T09:31:42.864351Z",
"url": "https://files.pythonhosted.org/packages/4d/c1/ebec613b5e9225a9f5655bc17ce07b0e27e5a8fb302a1c088be5567d9f6f/rstcheck-6.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-23 09:31:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rstcheck",
"github_project": "rstcheck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "rstcheck"
}
