flake8-sphinx-links

A Flake8 plugin to check docstrings for double backticked strings which should be links to the Python documentation.

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

flake8_sphinx_links can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install flake8_sphinx_links

To install with conda:

$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding

$ conda install flake8_sphinx_links

Code	Description
SXL001	Double backticked variable should be a link to Python documentation.

See pre-commit for instructions

Sample .pre-commit-config.yaml:

- repo: https://gitlab.com/pycqa/flake8
  rev: 3.8.1
  hooks:
   - id: flake8
     additional_dependencies: [flake8-sphinx-links==0.2.2]

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for flake8-sphinx-links 0.2.2
File	Size	Uploaded
flake8_sphinx_links-0.2.2.tar.gz	6.4 kB	Nov 22, 2023	Details

Table of built distributions (wheels) for flake8-sphinx-links 0.2.2
File	Interpreter	ABI	Platform	Reset
flake8_sphinx_links-0.2.2-py3-none-any.whl 17.8 kB Nov 22, 2023	Python 3	none	any	Details

Total release size: 24.2 kB

Download URL	flake8_sphinx_links-0.2.2.tar.gz
Size	6.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`6f0387ad9e2b408748cfa299c83daddad9184225cd7bc5759f9f7705f7d9445a`
BLAKE2b-256 checksum How to use checksums	`aaf8e2aeccc391fceff71713ae06fbcefb438c7314bcd3368f196ef0d7f6c427`
Upload date	Nov 22, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.18`

Download URL	flake8_sphinx_links-0.2.2-py3-none-any.whl
Size	17.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`059479f9f53f559c794caba63fe7914b8e0ae75137a5fe8e394ab9c35b072715`
BLAKE2b-256 checksum How to use checksums	`8f93fa5d2b7e7930f47e588de775c8b6694b7c0cefb75f9dace2cc98b668eaa6`
Upload date	Nov 22, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.18`