=======================
flake8_sphinx_links
=======================
.. start short_desc
**A Flake8 plugin to check docstrings for double backticked strings which should be links to the Python documentation.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/flake8-sphinx-links/latest?logo=read-the-docs
:target: https://flake8-sphinx-links.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Docs%20Check/badge.svg
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Linux/badge.svg
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Windows/badge.svg
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/macOS/badge.svg
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Flake8/badge.svg
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/mypy/badge.svg
:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/python-formate/flake8-sphinx-links/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/python-formate/flake8-sphinx-links/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/python-formate/flake8-sphinx-links/master?logo=coveralls
:target: https://coveralls.io/github/python-formate/flake8-sphinx-links?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/python-formate/flake8-sphinx-links?logo=codefactor
:target: https://www.codefactor.io/repository/github/python-formate/flake8-sphinx-links
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/flake8_sphinx_links
:target: https://pypi.org/project/flake8_sphinx_links/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/flake8_sphinx_links?logo=python&logoColor=white
:target: https://pypi.org/project/flake8_sphinx_links/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/flake8_sphinx_links
:target: https://pypi.org/project/flake8_sphinx_links/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/flake8_sphinx_links
:target: https://pypi.org/project/flake8_sphinx_links/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/flake8_sphinx_links?logo=anaconda
:target: https://anaconda.org/domdfcoding/flake8_sphinx_links
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/flake8_sphinx_links?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/flake8_sphinx_links
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/python-formate/flake8-sphinx-links
:target: https://github.com/python-formate/flake8-sphinx-links/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/python-formate/flake8-sphinx-links
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/python-formate/flake8-sphinx-links/v0.2.2
:target: https://github.com/python-formate/flake8-sphinx-links/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/python-formate/flake8-sphinx-links
:target: https://github.com/python-formate/flake8-sphinx-links/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/flake8_sphinx_links
:target: https://pypi.org/project/flake8_sphinx_links/
:alt: PyPI - Downloads
.. end shields
For example, \`\`True\`\` should be py\:obj:\`True\`, which Sphinx will render as a link to the Python documentation.
reStructuredText .rst files are not currently checked.
Installation
--------------
.. start installation
``flake8_sphinx_links`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install flake8_sphinx_links
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install flake8_sphinx_links
.. end installation
Flake8 codes
--------------
============== =====================================================================
Code Description
============== =====================================================================
SXL001 Double backticked variable should be a link to Python documentation.
============== =====================================================================
Use as a pre-commit hook
--------------------------
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
Sample ``.pre-commit-config.yaml``:
.. code-block:: yaml
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.1
hooks:
- id: flake8
additional_dependencies: [flake8-sphinx-links==0.2.2]
Raw data
{
"_id": null,
"home_page": "https://github.com/python-formate/flake8-sphinx-links",
"name": "flake8-sphinx-links",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "documentation,flake8,sphinx",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/aa/f8/e2aeccc391fceff71713ae06fbcefb438c7314bcd3368f196ef0d7f6c427/flake8_sphinx_links-0.2.2.tar.gz",
"platform": "Windows",
"description": "\n=======================\nflake8_sphinx_links\n=======================\n\n.. start short_desc\n\n**A Flake8 plugin to check docstrings for double backticked strings which should be links to the Python documentation.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t - |conda-version| |conda-platform|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/flake8-sphinx-links/latest?logo=read-the-docs\n\t:target: https://flake8-sphinx-links.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Linux/badge.svg\n\t:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Windows/badge.svg\n\t:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/macOS/badge.svg\n\t:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/Flake8/badge.svg\n\t:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/python-formate/flake8-sphinx-links/workflows/mypy/badge.svg\n\t:target: https://github.com/python-formate/flake8-sphinx-links/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/python-formate/flake8-sphinx-links/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/python-formate/flake8-sphinx-links/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/python-formate/flake8-sphinx-links/master?logo=coveralls\n\t:target: https://coveralls.io/github/python-formate/flake8-sphinx-links?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/python-formate/flake8-sphinx-links?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/python-formate/flake8-sphinx-links\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/flake8_sphinx_links\n\t:target: https://pypi.org/project/flake8_sphinx_links/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/flake8_sphinx_links?logo=python&logoColor=white\n\t:target: https://pypi.org/project/flake8_sphinx_links/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/flake8_sphinx_links\n\t:target: https://pypi.org/project/flake8_sphinx_links/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/flake8_sphinx_links\n\t:target: https://pypi.org/project/flake8_sphinx_links/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/flake8_sphinx_links?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/flake8_sphinx_links\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/flake8_sphinx_links?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/flake8_sphinx_links\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/python-formate/flake8-sphinx-links\n\t:target: https://github.com/python-formate/flake8-sphinx-links/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/python-formate/flake8-sphinx-links\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/python-formate/flake8-sphinx-links/v0.2.2\n\t:target: https://github.com/python-formate/flake8-sphinx-links/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/python-formate/flake8-sphinx-links\n\t:target: https://github.com/python-formate/flake8-sphinx-links/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2023\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/flake8_sphinx_links\n\t:target: https://pypi.org/project/flake8_sphinx_links/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nFor example, \\`\\`True\\`\\` should be py\\:obj:\\`True\\`, which Sphinx will render as a link to the Python documentation.\n\nreStructuredText .rst files are not currently checked.\n\nInstallation\n--------------\n\n.. start installation\n\n``flake8_sphinx_links`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install flake8_sphinx_links\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install flake8_sphinx_links\n\n.. end installation\n\nFlake8 codes\n--------------\n\n============== =====================================================================\nCode Description\n============== =====================================================================\nSXL001 Double backticked variable should be a link to Python documentation.\n============== =====================================================================\n\n\nUse as a pre-commit hook\n--------------------------\n\nSee `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions\n\nSample ``.pre-commit-config.yaml``:\n\n.. code-block:: yaml\n\n\t - repo: https://gitlab.com/pycqa/flake8\n\t rev: 3.8.1\n\t hooks:\n\t - id: flake8\n\t additional_dependencies: [flake8-sphinx-links==0.2.2]\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Flake8 plugin to check docstrings for double backticked strings which should be links to the Python documentation.",
"version": "0.2.2",
"project_urls": {
"Documentation": "https://flake8-sphinx-links.readthedocs.io/en/latest",
"Homepage": "https://github.com/python-formate/flake8-sphinx-links",
"Issue Tracker": "https://github.com/python-formate/flake8-sphinx-links/issues",
"Source Code": "https://github.com/python-formate/flake8-sphinx-links"
},
"split_keywords": [
"documentation",
"flake8",
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f93fa5d2b7e7930f47e588de775c8b6694b7c0cefb75f9dace2cc98b668eaa6",
"md5": "baf7292e149e58c543631bcdd716cf96",
"sha256": "059479f9f53f559c794caba63fe7914b8e0ae75137a5fe8e394ab9c35b072715"
},
"downloads": -1,
"filename": "flake8_sphinx_links-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "baf7292e149e58c543631bcdd716cf96",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17775,
"upload_time": "2023-11-22T11:24:55",
"upload_time_iso_8601": "2023-11-22T11:24:55.445985Z",
"url": "https://files.pythonhosted.org/packages/8f/93/fa5d2b7e7930f47e588de775c8b6694b7c0cefb75f9dace2cc98b668eaa6/flake8_sphinx_links-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aaf8e2aeccc391fceff71713ae06fbcefb438c7314bcd3368f196ef0d7f6c427",
"md5": "8a6abb7a7f9c24a56dc94e3f4e4efbf4",
"sha256": "6f0387ad9e2b408748cfa299c83daddad9184225cd7bc5759f9f7705f7d9445a"
},
"downloads": -1,
"filename": "flake8_sphinx_links-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "8a6abb7a7f9c24a56dc94e3f4e4efbf4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6435,
"upload_time": "2023-11-22T11:24:57",
"upload_time_iso_8601": "2023-11-22T11:24:57.163409Z",
"url": "https://files.pythonhosted.org/packages/aa/f8/e2aeccc391fceff71713ae06fbcefb438c7314bcd3368f196ef0d7f6c427/flake8_sphinx_links-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 11:24:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "python-formate",
"github_project": "flake8-sphinx-links",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "flake8-sphinx-links"
}
JSON
