flake8-sphinx-links 0.0.4

A flake8 plugin which checks docstrings for double backticked strings that should be links to the Python documentation.

A flake8 plugin which checks docstrings for double backticked strings that should be links to the Python documentation.

Docs
Tests
PyPI
Anaconda
Activity
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 http://conda.anaconda.org/domdfcoding
$ conda config --add channels http://conda.anaconda.org/conda-forge

• Then install

$ conda install flake8_sphinx_links

flake8 codes

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