flake8_sphinx_links

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

Docs
Tests
PyPI
Anaconda
Activity
QA
Other

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:

• First add the required channels

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

• Then install

$ conda install flake8_sphinx_links

Flake8 codes

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

Use as a pre-commit hook

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]