Skip to main content

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

Project description

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

Docs Documentation Build Status Docs Check Status
Tests Linux Test Status Windows Test Status macOS Test Status Coverage
PyPI PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel
Anaconda Conda - Package Version Conda - Platform
Activity GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads
QA CodeFactor Grade Flake8 Status mypy status pre-commit.ci status
Other License GitHub top language Requirements Status

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/conda-forge
$ conda config --add channels http://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.1]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8_sphinx_links-0.2.1.tar.gz (5.5 kB view hashes)

Uploaded source

Built Distribution

flake8_sphinx_links-0.2.1-py3-none-any.whl (18.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page