Sublime Text需通过SublimeLinter生态接入pydocstyle，且必须先在Python环境（全局或虚拟环境）中安装pydocstyle命令，再安装SublimeLinter与SublimeLinter-pydocstyle插件，最后在设置中显式配置paths指向pydocstyle可执行文件路径并可选调整args规则。
Sublime Text 本身不自带 pydocstyle 检查，必须通过 SublimeLinter 生态链接入，且不能跳过 Python 环境中 pydocstyle 的独立安装——这是最容易卡住的一步。
确认 pydocstyle 已全局或虚拟环境安装
SublimeLinter-pydocstyle 只是 Sublime 的“胶水插件”，真正执行检查的是你本地 Python 环境里的 pydocstyle 命令。如果终端里运行 pydocstyle --version 报错或找不到命令，插件必然失效。
- 推荐用 pip 安装：
pip install pydocstyle（全局）或pip install pydocstyle到当前项目虚拟环境 - 若使用 conda：运行
conda install -c conda-forge pydocstyle - 验证是否可用：
which pydocstyle（macOS/Linux）或where pydocstyle（Windows），记下完整路径，后续可能需手动配置
安装 SublimeLinter 和 SublimeLinter-pydocstyle 插件
这两个插件有依赖关系：SublimeLinter 是主框架，SublimeLinter-pydocstyle 是它的子插件。顺序不能反，否则后者不会激活。
- 按
Ctrl+Shift+P→ 输入Package Control: Install Package→ 先搜并安装SublimeLinter - 再同样流程安装
SublimeLinter-pydocstyle（注意名称含连字符，不是pydocstyle单独包） - 安装完成后，重启 Sublime Text 或手动触发
SublimeLinter: Enable Linting命令
配置 linter 路径与 Python 解释器匹配
当 Sublime 找不到 pydocstyle，常见原因是它默认调用系统 Python，而你的 pydocstyle 装在虚拟环境中。这时必须显式指定路径。
立即学习“Python免费学习笔记（深入）”；
- 打开
Preferences → Package Settings → SublimeLinter → Settings - 在
User配置中添加或修改paths字段，例如：
{
"paths": {
"linux": [],
"osx": ["/Users/yourname/.pyenv/shims"],
"windows": ["C:\Users\yourname\AppData\Local\Programs\Python\Python311\Scripts"]
}
}
路径要指向 pydocstyle.exe（Windows）或可执行脚本所在目录（如 pyenv/shims、venv/Scripts），不是 Python 解释器本身。
忽略特定 docstring 规则（如 D100、D401）
pydocstyle 默认检查非常严格，比如要求模块必须有 docstring（D100）、函数首句必须是祈使句（D401）。这些规则常被项目主动禁用。
- 在
SublimeLinter的User设置中，加入args配置：
"linters": {
"pydocstyle": {
"@disable": false,
"args": ["--select=D103,D202", "--match-dir=^((?!test|tests).)*$"],
"excludes": []
}
}
--select 显式列出想保留的规则（如只检查函数 docstring 格式 D103 和嵌套类方法空行 D202），比 --ignore 更可控；--match-dir 可跳过 test 目录避免干扰。
真正麻烦的从来不是插件装不上，而是 Sublime 用的 Python 环境和你写代码时用的不一致——路径、版本、venv 激活状态，三者差一个，pydocstyle 就静默失效，还不报错。
