一个 Flake8 插件，用于检查文档字符串中的双反引号字符串，这些字符串应该是 Python 文档的链接。
项目描述
一个 Flake8 插件，用于检查文档字符串中的双反引号字符串，这些字符串应该是 Python 文档的链接。
文档 |
|
|---|---|
测试 |
|
派皮 |
|
蟒蛇 |
|
活动 |
|
质量保证 |
|
其他 |
|
例如，``True`` 应该是 py:obj:`True`，Sphinx 将呈现为 Python 文档的链接。
当前未检查 reStructuredText .rst 文件。
安装
flake8_sphinx_links可以从 PyPI 或 Anaconda 安装。
使用pip安装：
$ python -m pip install flake8_sphinx_links使用conda安装：
首先添加需要的频道
$ conda config --add channels http://conda.anaconda.org/conda-forge $ conda config --add channels http://conda.anaconda.org/domdfcoding
然后安装
$ conda install flake8_sphinx_links
Flake8 代码
代码 |
描述 |
|---|---|
SXL001 |
双反引号变量应该是 Python 文档的链接。 |
用作预提交挂钩
有关说明，请参阅预提交
示例.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]
关
flake8_sphinx_links -0.2.1.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | e3d23df3a931f6a6b83a40a0dbb51e0d2706f16b3d22099c76536baaf6ffd19b |
|
| MD5 | 7ab66795905503a67a1a247277103230 |
|
| 布莱克2-256 | e8d5f7bfe86108e4d3d127e9091c8edc496b8ff68914b6db83ac6e4c71012069 |
关
flake8_sphinx_links -0.2.1-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 3921d016836fc6c6b32185409accf425393b31294c75839b4f0a1f07fffb3b7e |
|
| MD5 | 0e87d56c52e416b6be7d7de89cdd5872 |
|
| 布莱克2-256 | 1cf190ab5b7fb7aed548bc1c33329bbd0aa89ccc18d8a871e92e3a23b6de0d92 |