ohnoyoudidnt

ohnoyoudidnt是一个针对frc-docs使用的doc8 sphinx linter。它是对普通doc8 linter的扩展，包含自定义检查，旨在遵循frc-docs 风格指南

项目由TheTripleV创建

使用方法

手动

1. 确保已安装doc8。
2. 安装ohnoyoudidnt

python -m pip install ohnoyoudidnt

3. 使用以下方式运行linter

doc8

VS Code

1. 按照上面的1和2步骤操作
2. 安装reStructuredText VS Code扩展
3. 添加

    "restructuredtext.linter.name": "doc8",
    "restructuredtext.linter.extraArgs": [
        "--ignore D001",
        "--ignore D004",
        "--ignore D002",
        "--ignore WUMBO002"
    ],

到您的settings.json文件。

贡献指南

检查

• 检查永远不会返回行号 < 1
• 检查必须在每次导入时编译正则表达式模式，而不是每次文件导入时编译