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.
Dependencies:
Install it with:
python -m pip install blackdocThe 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 --help