一个Flake8插件，用于检查文档字符串中是否存在应该链接到Python文档的双反引号字符串。
项目描述
一个Flake8插件，用于检查文档字符串中是否存在应该链接到Python文档的双反引号字符串。
文档 |
|
|---|---|
测试 |
|
PyPI |
|
Anaconda |
|
活动 |
|
QA |
|
其他 |
|
例如，``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 https://conda.anaconda.org/conda-forge $ conda config --add channels https://conda.anaconda.org/domdfcoding
然后安装
$ conda install flake8_sphinx_links
Flake8 代码
代码 |
描述 |
|---|---|
SXL001 |
双反引号变量应该是指向 Python 文档的链接。 |
用作 pre-commit 钩子
有关说明，请参阅 pre-commit
示例 .pre-commit-config.yaml
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.1
hooks:
- id: flake8
additional_dependencies: [flake8-sphinx-links==0.2.2]
关闭
flake8_sphinx_links-0.2.2.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 6f0387ad9e2b408748cfa299c83daddad9184225cd7bc5759f9f7705f7d9445a |
|
| MD5 | 8a6abb7a7f9c24a56dc94e3f4e4efbf4 |
|
| BLAKE2b-256 | aaf8e2aeccc391fceff71713ae06fbcefb438c7314bcd3368f196ef0d7f6c427 |
关闭
flake8_sphinx_links-0.2.2-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 059479f9f53f559c794caba63fe7914b8e0ae75137a5fe8e394ab9c35b072715 |
|
| MD5 | baf7292e149e58c543631bcdd716cf96 |
|
| BLAKE2b-256 | 8f93fa5d2b7e7930f47e588de775c8b6694b7c0cefb75f9dace2cc98b668eaa6 |
