This repository has been archived by the owner on Mar 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
/
setup.cfg
88 lines (79 loc) · 2.9 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
85
86
87
88
[metadata]
package_name = spectroscopyx
description = Python package for spectroscopy
long_description = SpectroscoPyx is a community-developed and community-driven Python package for spectroscopic physics.
author = SpectroscoPyx Developers
license = BSD 3-Clause
url = https://spectroscopyx.org
edit_on_github = True
github_project = PlasmaPy/SpectroscoPyx
# install_requires should be formatted as a comma-separated list, e.g.:
# install_requires = astropy, scipy, matplotlib
install_requires = astropy
# version should be PEP386 compatible (http://www.python.org/dev/peps/pep-0386)
version = 0.1.dev3
minimum_python_version = 3.6
[build_sphinx]
source-dir = docs
build-dir = docs/_build
all_files = 1
[build_docs]
source-dir = docs
build-dir = docs/_build
all_files = 1
[upload_docs]
upload-dir = docs/_build/html
show-response = 1
[tool:pytest]
minversion = 3.0
doctest_plus = enabled
norecursedirs = "astropy_helpers" "docs" "build" "docs/_build" "examples" "auto_examples"
filterwarnings =
once::DeprecationWarning
once::PendingDeprecationWarning
[ah_bootstrap]
auto_use = True
[pycodestyle]
# E101 - mix of tabs and spaces
# W191 - use of tabs
# W291 - trailing whitespace
# W292 - no newline at end of file
# W293 - trailing whitespace
# W391 - blank line at end of file
# E111 - 4 spaces per indentation level
# E112 - 4 spaces per indentation level
# E113 - 4 spaces per indentation level
# E901 - SyntaxError or IndentationError
# E902 - IOError
# select = E226,E241,E242,E704,W504
exclude = astropy_helpers,ah_bootstrap.py,ez_setup.py,version.py,build
max-line-length = 99
[pydocstyle]
# The error codes for pydocstyle include:
#
# *D107: Missing docstring in __init__
# D202: No blank lines allowed after function docstring
# *D203: 1 blank line required before class docstring
# D205: 1 blank line required between summary line and description
# *D212: Multi-line docstring summary should start at the first line
# D213: Multi-line docstring summary should start at the second line
# D302: Use u""" for Unicode docstrings
# D400: First line should end with a period
# *D402: First line should not be the function's "signature"
# D405: Section name should be properly capitalized
# D412: No blank lines allowed between a section header and its content
# *D413: Missing blank line after last section
#
# The error codes marked with an asterisk are ignored by default when
# using the numpy convention. The full set of error codes are available at:
#
# http://www.pydocstyle.org/en/latest/error_codes.html
#
# D302 is unnecessary as we are using Python 3.6+. Ignoring D202 allows blank
# lines to be put on either side of code "paragraphs" at the beginning of a
# function. D205 and D400 are ignored to allow the "one-liner" to exceed one
# line, which is sometimes necessary for even concise descriptions of plasma
# physics functions and classes.
convention = numpy
add-select = D402,D413
add-ignore = D202,D205,D302,D400