flake8-sphinx-links 0.2.2
A Flake8 plugin to check docstrings for double backticked strings which should be links to the Python documentation.
License: MIT
Requires Python: >=3.6
Keywords: documentation,flake8,sphinx


=======================
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]