Run `clang-format` on C++ code blocks in documentation files
Project description
clang-format-docs
Run clang-format
on C++ code blocks in documentation files.
This project is derivative work of blacken-docs
. License from blacken-docs
is included in LICENSE_blacken_docs
install
pip install clang-format-docs
Usage
clang-format-docs
will take markdown files and search for C++ code blocks e.g
```c++
void hello(){
std::cout << "Hello world\n"
}
```
and format them using clang-format
, i.e
clang-format-docs file.md
will rewrite the file with clang-format applied. Also note that you can pass in a different format style using
clang-format-docs --style=LLVM file.md
or using a clang-format config file
clang-format-docs -style=file:my_clang_format.txt file.md
Usage with pre-commit
See pre-commit for instructions
Sample .pre-commit-config.yaml
:
- repo: https://github.com/finsberg/clang-format-docs
rev: v0.2.1
hooks:
- id: clang-format-docs
additional_dependencies: [clang-format==14.0.6]
Project details
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
Close
Hashes for clang_format_docs-0.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80a9707a3d23426b617dac81c8eb4dfda29b2db21fdb3f08ea7857e7383ab55a |
|
MD5 | bf38364bc0c2983469e5f19b585e541e |
|
BLAKE2b-256 | 104d453eb0677be269410e18731f43ab31626bb43b57e0391337fb125dfd5307 |