在文档文件中的python代码块上运行“black”
blacken-docs的Python项目详细描述
黑色文档
在文档文件中的python代码块上运行black
。
安装
pip install blacken-docs
用法
blacken-docs
提供一个可执行文件(blacken-docs
),它将修改
.rst
/.md
文件就位。
它当前支持以下^{
-l
/--line-length
-t
/--target-version
-S
/--skip-string-normalization
可以使用以下附加参数:
-E
/--skip-errors
blacken-docs
将格式化以下块类型的代码:
(降价)
```python def hello(): print("hello world") ```
(重新设置)
..code-block::pythondefhello():print("hello world")
与预提交一起使用
有关说明,请参见pre-commit。
样本.pre-commit-config.yaml
:
-repo:https://github.com/asottile/blacken-docsrev:v1.3.0hooks:-id:blacken-docsadditional_dependencies:[black==...]
由于black
当前是一个移动目标,建议锁定black
使用additional_dependencies
转到特定版本。