Metadata-Version: 2.1
Name: flake8_sphinx_links
Version: 0.0.4
Summary: A flake8 plugin which checks docstrings for double backticked strings that should be links to the Python documentation.
Home-page: https://github.com/domdfcoding/flake8_sphinx_links
Author: Dominic Davis-Foster
Author-email: dominic@davis-foster.co.uk
License: MIT License
Project-URL: Documentation, https://flake8_sphinx_links.readthedocs.io
Project-URL: Issue_Tracker, https://github.com/domdfcoding/flake8_sphinx_links/issues
Project-URL: Source_Code, https://github.com/domdfcoding/flake8_sphinx_links
Description: =======================
        flake8_sphinx_links
        =======================
        
        .. start short_desc
        
        **A flake8 plugin which checks docstrings for double backticked strings that 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
        	  - |travis| |actions_windows| |actions_macos| |coveralls| |codefactor|
        	* - PyPI
        	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
        	* - Anaconda
        	  - |conda-version| |conda-platform|
        	* - Activity
        	  - |commits-latest| |commits-since| |maintained|
        	* - Other
        	  - |license| |language| |requires| |pre_commit|
        
        .. |docs| image:: https://img.shields.io/readthedocs/flake8-sphinx-links/latest?logo=read-the-docs
        	:target: https://flake8-sphinx-links.readthedocs.io/en/latest/?badge=latest
        	:alt: Documentation Status
        
        .. |docs_check| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/Docs%20Check/badge.svg
        	:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22Docs+Check%22
        	:alt: Docs Check Status
        
        .. |travis| image:: https://img.shields.io/travis/com/domdfcoding/flake8-sphinx-links/master?logo=travis
        	:target: https://travis-ci.com/domdfcoding/flake8-sphinx-links
        	:alt: Travis Build Status
        
        .. |actions_windows| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/Windows%20Tests/badge.svg
        	:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22Windows+Tests%22
        	:alt: Windows Tests Status
        
        .. |actions_macos| image:: https://github.com/domdfcoding/flake8-sphinx-links/workflows/macOS%20Tests/badge.svg
        	:target: https://github.com/domdfcoding/flake8-sphinx-links/actions?query=workflow%3A%22macOS+Tests%22
        	:alt: macOS Tests Status
        
        .. |requires| image:: https://requires.io/github/domdfcoding/flake8-sphinx-links/requirements.svg?branch=master
        	:target: https://requires.io/github/domdfcoding/flake8-sphinx-links/requirements/?branch=master
        	:alt: Requirements Status
        
        .. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/flake8-sphinx-links/master?logo=coveralls
        	:target: https://coveralls.io/github/domdfcoding/flake8-sphinx-links?branch=master
        	:alt: Coverage
        
        .. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/flake8-sphinx-links?logo=codefactor
        	:target: https://www.codefactor.io/repository/github/domdfcoding/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/domdfcoding/flake8-sphinx-links
        	:target: https://github.com/domdfcoding/flake8-sphinx-links/blob/master/LICENSE
        	:alt: License
        
        .. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/flake8-sphinx-links
        	:alt: GitHub top language
        
        .. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/flake8-sphinx-links/v0.0.4
        	:target: https://github.com/domdfcoding/flake8-sphinx-links/pulse
        	:alt: GitHub commits since tagged version
        
        .. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/flake8-sphinx-links
        	:target: https://github.com/domdfcoding/flake8-sphinx-links/commit/master
        	:alt: GitHub last commit
        
        .. |maintained| image:: https://img.shields.io/maintenance/yes/2020
        	:alt: Maintenance
        
        .. |pre_commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
        	:target: https://github.com/pre-commit/pre-commit
        	:alt: pre-commit
        
        .. 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 http://conda.anaconda.org/domdfcoding
        		$ conda config --add channels http://conda.anaconda.org/conda-forge
        
        	* 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.
        ============== =====================================================================
        
Platform: Windows
Platform: macOS
Platform: Linux
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: all
