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_linksTo 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. |
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flake8_sphinx_links-0.0.4.tar.gz.
File metadata
- Download URL: flake8_sphinx_links-0.0.4.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cc866e513da9bb2c3dee3bc468d6dfa6d564570c63a87031020046aae6b2532d
|
|
| MD5 |
5fbda3cfa34487a2eb202cb696a95614
|
|
| BLAKE2b-256 |
f861a50c4083bf854023478a3268615d7edf95252aba50cf2d4e886998f68ee3
|
File details
Details for the file flake8_sphinx_links-0.0.4-py3-none-any.whl.
File metadata
- Download URL: flake8_sphinx_links-0.0.4-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
409c83867555d22605b92603410708dc01ed15a37a94ca81428480ae9b6a9c1e
|
|
| MD5 |
8cc7ae56592bd140129a020a7717a092
|
|
| BLAKE2b-256 |
eec4296ee6d1b1e012da70bcdc2abfae5ca3e91c9349a17c52cb8c89ad576efb
|
