Contents Menu Expand
flake8-sphinx-links 0.2.2 documentation
flake8-sphinx-links 0.2.2 documentation
  • Home
  • Usage
  • Examples
  • API Reference
  • Downloading source code
  • License

Links

  • GitHub
  • PyPI
  • Contributing Guide

flake8_sphinx_links¶

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

Other

License GitHub top language Requirements Status

Installation¶

python3 -m pip install flake8-sphinx-links --user

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
python3 -m pip install git+https://github.com/python-formate/flake8-sphinx-links@master --user

Contents¶

  • Usage
    • Flake8 codes
    • Pre-commit hook
  • Examples
  • API Reference
    • Plugin
    • Visitor
    • exc
    • py_obj
    • py_obj_python
    • regex
  • Downloading source code
    • Building from source
  • License

View the Function Index or browse the Source Code.

Browse the GitHub Repository

Next
Usage
Copyright © 2020-2021 Dominic Davis-Foster | Built with Sphinx and @pradyunsg's Furo theme. | Show Source
Contents
  • flake8_sphinx_links
    • Installation
    • Contents