misc: add black files/notes

This commit is contained in:
Frédéric Péters 2021-01-11 19:11:05 +01:00
parent 2bf37aaa7e
commit 7980117b8b
3 changed files with 21 additions and 0 deletions

2
.git-blame-ignore-revs Normal file
View File

@ -0,0 +1,2 @@
# trivial: apply black
2bf37aaa7e459d429fca284f2de60add5841d063

8
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,8 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/psf/black
rev: 20.8b1
hooks:
- id: black
args: ['--target-version', 'py37', '--skip-string-normalization', '--line-length', '110']

11
README
View File

@ -12,6 +12,17 @@ Variables
- logo_link_url: link to be used for the top logo, defaults to the site root.
Code Style
----------
black is used to format the Python code, using thoses parameters:
black --target-version py37 --skip-string-normalization --line-length 110
There is .pre-commit-config.yaml to use pre-commit to automatically run black
before commits. (execute `pre-commit install` to install the git hook.)
License
-------