Run `black` on python code blocks in documentation files
Project description
blacken-docs
Run black on python code blocks in documentation files.
install
pip install blacken-docs
usage
blacken-docs provides a single executable (blacken-docs) which will modify
.rst / .md files in place.
It currently supports the following black
options:
-l/--line-length-t/--target-version-S/--skip-string-normalization
Following additional parameters can be used:
-E/--skip-errors
blacken-docs will format code in the following block types:
(markdown)
```python
def hello():
print("hello world")
```
(rst)
.. code-block:: python
def hello():
print("hello world")
usage with pre-commit
See pre-commit for instructions
Sample .pre-commit-config.yaml:
- repo: https://github.com/asottile/blacken-docs
rev: v1.0.0
hooks:
- id: blacken-docs
additional_dependencies: [black==...]
Since black is currently a moving target, it is suggested to pin black
to a specific version using additional_dependencies.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
blacken_docs-1.0.0.tar.gz
(4.0 kB
view hashes)
Built Distribution
Close
Hashes for blacken_docs-1.0.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 453b445ae60300a9bb92e0b372936ddc68d9c054ab3d3535d57ab10a56ef9b7b |
|
| MD5 | 13e000f5a47b19ec910fdc62d1e5f8a9 |
|
| BLAKE2b-256 | 69065f8e6eeb69268986051f540358fd17a029f331667dbc6b32447cc4d5e962 |
