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 |
|
---|---|
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 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.0]
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
Built Distribution
Hashes for flake8_sphinx_links-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54e09ed50c89022ff463460a7f699541dc7bf74e64a19a185f939ec3a9771f73 |
|
MD5 | d3394854ca2fa667f1f394c69dd27f93 |
|
BLAKE2b-256 | f29a5b9c254d59011480dc3d00fedb42381eb9cb4071d4b56639b1b722e7a772 |
Hashes for flake8_sphinx_links-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6ab6bd9813b40dd348763627eae04d185f07ba4a3a2e1ebeb00131567c91aee |
|
MD5 | 5133d68d16f9fa10dae3631bb0183fb9 |
|
BLAKE2b-256 | df955d2cefc97901e05b4cc4b7379aa883c7b3de7b25624e8f4868e837409b19 |