run black on documentation code snippets
Reason this release was yanked:
still a serious bug with triple-quoted strings
Project description
blackdoc is a tool that applies black to code in documentation.
It was originally a rewrite of a gist and called black-doctest. In April 2020, it was renamed to blackdoc.
Installation
Dependencies:
Install it with:
python -m pip install blackdocUsage
The commandline interface supports two modes: checking and inplace reformatting.
python -m blackdoc --helpIn inplace reformatting mode, it will reformat the doctest lines and write them back to disk:
# on explicitly mentioned files
python -m blackdoc file1.py file2.py
# on the whole directory
python -m blackdoc .When checking, it will report the changed files but will not write them to disk:
python -m blackdoc --check .It is also possible to use the entrypoint script:
blackdoc --helpRelease 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
Built Distribution
File details
Details for the file blackdoc-0.3.6.tar.gz.
File metadata
- Download URL: blackdoc-0.3.6.tar.gz
- Upload date:
- Size: 35.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e7e24e67b4eef3abd9d7d8b61b6c6948cd678315ae2def3b1fc07cedf68b6acf |
|
| MD5 | c337552377410ab230c40903fc05f67d |
|
| BLAKE2b-256 | 798fe351c09beff1dd095cdd1b81d80798ea9b35f3c051a43565f371bf3ef4f0 |
File details
Details for the file blackdoc-0.3.6-py3-none-any.whl.
File metadata
- Download URL: blackdoc-0.3.6-py3-none-any.whl
- Upload date:
- Size: 30.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cb5e742e8062d21e3fee1dfa40f6441cd03be14348ed3c6ec2d5a974fe4f92ac |
|
| MD5 | d9935049549995acd16d48bfe78128ce |
|
| BLAKE2b-256 | 26092c01a747b4d132028e09d3a769a974c6c0a965612e95425f2ebf2e10924d |
