-
Notifications
You must be signed in to change notification settings - Fork 127
/
setup.cfg
84 lines (80 loc) · 2.15 KB
/
setup.cfg
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
[flake8]
# include messages from:
select =
E,F,W, # flake8
N, # pep8-naming
D, # flake8-docstrings
RST # flake8-rst-docstrings
ignore =
# line breaks should occur before the binary operator
W503,
# allow occasional use of uppercase variable and argument names (e.g. N)
N806,N803,
# match yapf formatting style
E126,E133,
# do not document __init__ separately from the class
D107,
# Google Python style is not RST until after processed by Napoleon
# See https://github.com/peterjc/flake8-rst-docstrings/issues/17
RST201,RST203,RST301,
# Allow :nowrap: in math directives
RST307
# Allow backslashes in docstrings so we can have both line continuations and LaTeX math
D301
# do not require docstrings in unit test files
# F401 ignore unused imports in __init__.py files (these are for users)
# D214 ignore overindented sections in Trigger - this is Google napoleon formatting
# N816 ignore mixed case kT variables
# D10* howto guides do not need docstrings
per-file-ignores =
*/pytest/*.py:D100,D101,D102,D103,D104,D105,D106
sphinx-doc/howto/*.py:D100,D101,D102,D103,D104,D105,D106,N816
*/__init__.py: F401
hoomd/version.py: F401
hoomd/trigger.py: D214
# TODO: These should be removed as files are ported or removed
# These also need to be removed in .pre-commit-config.yaml
exclude = .git,
__pycache__,
build,
hoomd/extern,
hoomd/metal,
max_line_length = 80
max_doc_length = 80
hang_closing = True
docstring-convention = google
rst-directives =
code-blocks,
deprecated,
py:attribute,
py:method,
seealso,
versionadded,
versionchanged,
todo,
rst-roles =
attr,
class,
doc,
file,
func,
meth,
mod,
py:mod,
py:class,
py:meth,
py:func,
py:exc,
ref,
[pydocstyle]
convention = google
# do not document __init__ separately from the class
add_ignore = D107
[yapf]
based_on_style = google
align_closing_bracket_with_visual_indent = True
split_before_arithmetic_operator = True
split_before_bitwise_operator = True
split_before_logical_operator = True
blank_line_before_module_docstring = True
split_before_dot = True