.. image:: https://github.com/keewis/blackdoc/workflows/CI/badge.svg?branch=main :target: https://github.com/keewis/blackdoc/actions .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/python/black .. image:: https://readthedocs.org/projects/blackdoc/badge/?version=latest :target: https://blackdoc.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
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.
.. _gist: https://gist.github.com/mattharrison/2a1a263597d80e99cf85e898b800ec32 .. _black: https://github.com/psf/black
Dependencies:
black_more-itertools_rich_tomli_pathspec_.. _more-itertools: https://github.com/more-itertools/more-itertools .. _rich: https://github.com/textualize/rich .. _tomli: https://github.com/hukkin/tomli .. _pathspec: https://github.com/cpburnz/python-pathspec
Install it with:
.. code:: bash
python -m pip install blackdoc
The commandline interface supports two modes: checking and inplace reformatting.
.. code:: bash
python -m blackdoc --help
In inplace reformatting mode, it will reformat the doctest lines and write them back to disk:
.. code:: bash
# 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:
.. code:: bash
python -m blackdoc --check .
It is also possible to use the entrypoint script:
.. code:: bash
blackdoc --help
This repository defines a pre-commit hook:
.. code:: yaml
hooks: ...
It is recommended to pin black in order to avoid having different versions for each contributor. To automatically synchronize this pin with the version of the black hook, use the blackdoc-autoupdate-black hook:
.. code:: yaml
hooks: ...
Note that this hook is not run on pre-commit autoupdate.
FAQs
run black on documentation code snippets
We found that blackdoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.