=============
rstcheck-core
=============
+-------------------+---------------------------------------------------------------------------------------------+
| **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| |
+-------------------+---------------------------------------------------------------------------------------------+
Library for checking 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_core
To use pyproject.toml for configuration::
$ pip install rstcheck_core[toml]
To add sphinx support::
$ pip install rstcheck_core[sphinx]
To add YAML checking support::
$ pip install rstcheck_core[yaml]
Supported languages in code blocks
==================================
- Bash
- Doctest
- C (C99)
- C++ (C++11)
- JSON
- XML
- Python
- reStructuredText
- YAML
.. _read-the-docs: https://rstcheck-core.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-core.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-core/latest.svg?style=flat-square&logo=read-the-docs&logoColor=white&label=Read%20the%20Docs
:target: https://rstcheck-core.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-core/test.yml?branch=main&style=flat-square&logo=github&label=Test%20code
:target: https://github.com/rstcheck/rstcheck-core/actions/workflows/test.yaml
:alt: Test status
.. |gha_docu| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck-core/documentation.yml?branch=main&style=flat-square&logo=github&label=Test%20documentation
:target: https://github.com/rstcheck/rstcheck-core/actions/workflows/documentation.yaml
:alt: Documentation status
.. |gha_qa| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck-core/qa.yml?branch=main&style=flat-square&logo=github&label=QA
:target: https://github.com/rstcheck/rstcheck-core/actions/workflows/qa.yaml
:alt: QA status
.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/rstcheck/rstcheck-core/main.svg
:target: https://results.pre-commit.ci/latest/github/rstcheck-core/rstcheck/main
:alt: pre-commit status
.. PyPI
.. |pypi_release| image:: https://img.shields.io/pypi/v/rstcheck-core.svg?style=flat-square&logo=pypi&logoColor=FBE072
:target: https://pypi.org/project/rstcheck-core/
:alt: PyPI - Package latest release
.. |pypi_py_versions| image:: https://img.shields.io/pypi/pyversions/rstcheck-core.svg?style=flat-square&logo=python&logoColor=FBE072
:target: https://pypi.org/project/rstcheck-core/
:alt: PyPI - Supported Python Versions
.. |pypi_implementations| image:: https://img.shields.io/pypi/implementation/rstcheck-core.svg?style=flat-square&logo=python&logoColor=FBE072
:target: https://pypi.org/project/rstcheck-core/
:alt: PyPI - Supported Implementations
.. |pypi_format| image:: https://img.shields.io/pypi/format/rstcheck-core.svg?style=flat-square&logo=pypi&logoColor=FBE072
:target: https://pypi.org/project/rstcheck-core/
:alt: PyPI - Format
.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/rstcheck-core.svg?style=flat-square&logo=pypi&logoColor=FBE072
:target: https://pypi.org/project/rstcheck-core/
:alt: PyPI - Monthly downloads
.. GitHub
.. |gh_tag| image:: https://img.shields.io/github/v/tag/rstcheck/rstcheck-core.svg?sort=semver&style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck-core/tags
:alt: Github - Latest Release
.. |gh_last_commit| image:: https://img.shields.io/github/last-commit/rstcheck/rstcheck-core.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck-core/commits/main
:alt: GitHub - Last Commit
.. |gh_stars| image:: https://img.shields.io/github/stars/rstcheck/rstcheck-core.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck-core/stargazers
:alt: Github - Stars
.. |gh_forks| image:: https://img.shields.io/github/forks/rstcheck/rstcheck-core.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck-core/network/members
:alt: Github - Forks
.. |gh_contributors| image:: https://img.shields.io/github/contributors/rstcheck/rstcheck-core.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck-core/graphs/contributors
:alt: Github - Contributors
.. |gh_watchers| image:: https://img.shields.io/github/watchers/rstcheck/rstcheck-core.svg?style=flat-square&logo=github
:target: https://github.com/rstcheck/rstcheck-core/watchers/
:alt: Github - Watchers
Raw data
{
"_id": null,
"home_page": null,
"name": "rstcheck-core",
"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/ff/df/2f72e358787f198c9f3d4645c25c790b6186085a537e3986e0e0f85073fc/rstcheck-core-1.2.1.tar.gz",
"platform": null,
"description": "=============\nrstcheck-core\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\nLibrary for checking 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_core\n\nTo use pyproject.toml for configuration::\n\n $ pip install rstcheck_core[toml]\n\nTo add sphinx support::\n\n $ pip install rstcheck_core[sphinx]\n\nTo add YAML checking support::\n\n $ pip install rstcheck_core[yaml]\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- YAML\n\n\n.. _read-the-docs: https://rstcheck-core.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-core.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-core/latest.svg?style=flat-square&logo=read-the-docs&logoColor=white&label=Read%20the%20Docs\n :target: https://rstcheck-core.readthedocs.io/en/latest/\n :alt: Read the Docs - Build Status (latest)\n\n\n.. CI\n\n\n.. |gha_tests| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck-core/test.yml?branch=main&style=flat-square&logo=github&label=Test%20code\n :target: https://github.com/rstcheck/rstcheck-core/actions/workflows/test.yaml\n :alt: Test status\n\n.. |gha_docu| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck-core/documentation.yml?branch=main&style=flat-square&logo=github&label=Test%20documentation\n :target: https://github.com/rstcheck/rstcheck-core/actions/workflows/documentation.yaml\n :alt: Documentation status\n\n.. |gha_qa| image:: https://img.shields.io/github/actions/workflow/status/rstcheck/rstcheck-core/qa.yml?branch=main&style=flat-square&logo=github&label=QA\n :target: https://github.com/rstcheck/rstcheck-core/actions/workflows/qa.yaml\n :alt: QA status\n\n.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/rstcheck/rstcheck-core/main.svg\n :target: https://results.pre-commit.ci/latest/github/rstcheck-core/rstcheck/main\n :alt: pre-commit status\n\n.. PyPI\n\n.. |pypi_release| image:: https://img.shields.io/pypi/v/rstcheck-core.svg?style=flat-square&logo=pypi&logoColor=FBE072\n :target: https://pypi.org/project/rstcheck-core/\n :alt: PyPI - Package latest release\n\n.. |pypi_py_versions| image:: https://img.shields.io/pypi/pyversions/rstcheck-core.svg?style=flat-square&logo=python&logoColor=FBE072\n :target: https://pypi.org/project/rstcheck-core/\n :alt: PyPI - Supported Python Versions\n\n.. |pypi_implementations| image:: https://img.shields.io/pypi/implementation/rstcheck-core.svg?style=flat-square&logo=python&logoColor=FBE072\n :target: https://pypi.org/project/rstcheck-core/\n :alt: PyPI - Supported Implementations\n\n.. |pypi_format| image:: https://img.shields.io/pypi/format/rstcheck-core.svg?style=flat-square&logo=pypi&logoColor=FBE072\n :target: https://pypi.org/project/rstcheck-core/\n :alt: PyPI - Format\n\n.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/rstcheck-core.svg?style=flat-square&logo=pypi&logoColor=FBE072\n :target: https://pypi.org/project/rstcheck-core/\n :alt: PyPI - Monthly downloads\n\n\n\n.. GitHub\n\n.. |gh_tag| image:: https://img.shields.io/github/v/tag/rstcheck/rstcheck-core.svg?sort=semver&style=flat-square&logo=github\n :target: https://github.com/rstcheck/rstcheck-core/tags\n :alt: Github - Latest Release\n\n.. |gh_last_commit| image:: https://img.shields.io/github/last-commit/rstcheck/rstcheck-core.svg?style=flat-square&logo=github\n :target: https://github.com/rstcheck/rstcheck-core/commits/main\n :alt: GitHub - Last Commit\n\n.. |gh_stars| image:: https://img.shields.io/github/stars/rstcheck/rstcheck-core.svg?style=flat-square&logo=github\n :target: https://github.com/rstcheck/rstcheck-core/stargazers\n :alt: Github - Stars\n\n.. |gh_forks| image:: https://img.shields.io/github/forks/rstcheck/rstcheck-core.svg?style=flat-square&logo=github\n :target: https://github.com/rstcheck/rstcheck-core/network/members\n :alt: Github - Forks\n\n.. |gh_contributors| image:: https://img.shields.io/github/contributors/rstcheck/rstcheck-core.svg?style=flat-square&logo=github\n :target: https://github.com/rstcheck/rstcheck-core/graphs/contributors\n :alt: Github - Contributors\n\n.. |gh_watchers| image:: https://img.shields.io/github/watchers/rstcheck/rstcheck-core.svg?style=flat-square&logo=github\n :target: https://github.com/rstcheck/rstcheck-core/watchers/\n :alt: Github - Watchers\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Checks syntax of reStructuredText and code blocks nested within it",
"version": "1.2.1",
"project_urls": {
"Changelog": "https://github.com/rstcheck/rstcheck-core/blob/main/CHANGELOG.md",
"Documentation": "https://rstcheck-core.readthedocs.io/en/latest/",
"Repository": "https://github.com/rstcheck/rstcheck-core"
},
"split_keywords": [
"restructuredtext",
" rst",
" linter",
" static-analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe8a36bd12939244d220922acf52babd77da1de0f9f527c13ff6d75be280e810",
"md5": "c798a187e705ca37a252da995fd0bdaf",
"sha256": "1c100de418b6c9e14d9cf6558644d0ab103fdc447f891313882d02df3a3c52ba"
},
"downloads": -1,
"filename": "rstcheck_core-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c798a187e705ca37a252da995fd0bdaf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27198,
"upload_time": "2024-03-23T09:26:53",
"upload_time_iso_8601": "2024-03-23T09:26:53.188841Z",
"url": "https://files.pythonhosted.org/packages/fe/8a/36bd12939244d220922acf52babd77da1de0f9f527c13ff6d75be280e810/rstcheck_core-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ffdf2f72e358787f198c9f3d4645c25c790b6186085a537e3986e0e0f85073fc",
"md5": "90fd7943701b506649847daae14e27f2",
"sha256": "9b330020d912e2864f23f332c1a0569463ca3b06b8fee7b7bdd201b055f7f831"
},
"downloads": -1,
"filename": "rstcheck-core-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "90fd7943701b506649847daae14e27f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 52638,
"upload_time": "2024-03-23T09:26:55",
"upload_time_iso_8601": "2024-03-23T09:26:55.359343Z",
"url": "https://files.pythonhosted.org/packages/ff/df/2f72e358787f198c9f3d4645c25c790b6186085a537e3986e0e0f85073fc/rstcheck-core-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-23 09:26:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rstcheck",
"github_project": "rstcheck-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "rstcheck-core"
}
JSON
