IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
c848d4dd37
sphinx/setup.cfg

83 lines
1.7 KiB
INI
Raw Normal View History

setup.cfg: Restructure file Place configuration of the package itself first in the file, followed by configuration of other tools. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-21 08:19:28 -05:00
[metadata]
license_file = LICENSE
Add new README, adapt setup.py.
2008-03-18 14:37:05 -05:00
[egg_info]
Support PEP-440 version spec for developers.
2015-03-14 02:46:24 -05:00
tag_build = .dev
Add new README, adapt setup.py.
2008-03-18 14:37:05 -05:00
tag_date = true
[aliases]
egg_info: drop --no-svn-revision option because it has been deprecated
2017-04-02 04:58:22 -05:00
release = egg_info -Db ''
Add setup.py "upload" alias for automatic package signing.
2013-02-05 02:19:52 -06:00
upload = upload --sign --identity=36580288
Add new README, adapt setup.py.
2008-03-18 14:37:05 -05:00
setup.cfg: Restructure file Place configuration of the package itself first in the file, followed by configuration of other tools. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-21 08:19:28 -05:00
[build_sphinx]
warning-is-error = 1
Add i18n support, thanks to Horst Gutmann.
2008-08-08 05:54:00 -05:00
[extract_messages]
mapping_file = babel.cfg
output_file = sphinx/locale/sphinx.pot
Fix #3833: command line messages are translated unintentionally
2017-06-25 03:35:42 -05:00
keywords = _ __ l_ lazy_gettext
Add i18n support, thanks to Horst Gutmann.
2008-08-08 05:54:00 -05:00
[update_catalog]
input_file = sphinx/locale/sphinx.pot
domain = sphinx
output_dir = sphinx/locale/
[compile_catalog]
domain = sphinx
directory = sphinx/locale/
Use universal wheel package. removing build directory procedure is not needed anymore.
2014-10-09 10:01:57 -05:00
add flake8 testing
2015-03-07 00:45:43 -06:00
[flake8]
Update setup.cfg
2016-12-24 06:03:41 -06:00
max-line-length = 95
Fix flake8 violations
2018-07-16 07:03:32 -05:00
ignore = E116,E241,E251,E741,W504,I101
test: Apply flake8 to tests/ directory
2020-11-15 02:11:18 -06:00
exclude = .git,.tox,.venv,tests/roots/*,build/*,doc/_build/*,sphinx/search/*,doc/usage/extensions/example*.py
Use flake8-import-order
2018-01-27 10:52:16 -06:00
application-import-names = sphinx
import-order-style = smarkets
test: Apply flake8 to tests/ directory
2020-11-15 02:11:18 -06:00
per-file-ignores =
tests/*: E501
setup.cfg: Enable 'warning-is-error' Dog food this feature. Validated with the following (broken) change: --- a/doc/contents.rst +++ b/doc/contents.rst @@ -18,6 +18,9 @@ Sphinx documentation contents intl theming setuptools + + .. This is broken!!! + templating latex markdown Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-02-24 12:39:51 -06:00
setup: Configure flake8 extension as a local plugin We don't want to install this as a system plugin. Now that flake8 3.5.0 is in the wild, we can use this. Signed-off-by: Stephen Finucane <stephen@that.guru> Fixes: #4492
2018-01-26 03:41:50 -06:00
[flake8:local-plugins]
extension =
X101 = utils.checks:sphinx_has_header
Give local-plugins.paths option to flake8 It will be available on flake8-3.5.0+. (see https://gitlab.com/pycqa/flake8/issues/379)
2018-01-28 00:20:50 -06:00
paths =
.
setup: Configure flake8 extension as a local plugin We don't want to install this as a system plugin. Now that flake8 3.5.0 is in the wild, we can use this. Signed-off-by: Stephen Finucane <stephen@that.guru> Fixes: #4492
2018-01-26 03:41:50 -06:00
Sort imports with isort Keep imports alphabetically sorted and their order homogeneous across Python source files. The isort project has more feature and is more active than the flake8-import-order plugin. Most issues caught were simply import ordering from the same module. Where imports were purposefully placed out of order, tag with isort:skip.
2020-11-11 05:00:27 -06:00
[isort]
line_length = 95
mypy: Move configuration to 'setup.cfg' Less top-level files = winning [1]. [1] https://mypy.readthedocs.io/en/stable/config_file.html Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-02 13:23:59 -05:00
[mypy]
Specify the target Python version in the mypy configuration Currently targets Python 3.5. This caught a bug. The subprocess.run() function only started taking the 'encoding' keyword argument starting with Python 3.6.
2019-08-16 14:08:28 -05:00
python_version = 3.5
mypy: Enable disallow_incomplete_defs flag for type checking
2019-12-29 08:56:30 -06:00
disallow_incomplete_defs = True
mypy: Make output a little friendlier Two default-disabled options are enabled: - show_column_numbers - Shows context notes before errors - show_error_context - Shows column numbers in error messages This should make the output of mypy a little easier to parse. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-03 04:53:06 -05:00
show_column_numbers = True
show_error_context = True
mypy: Move configuration to 'setup.cfg' Less top-level files = winning [1]. [1] https://mypy.readthedocs.io/en/stable/config_file.html Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-02 13:23:59 -05:00
ignore_missing_imports = True
follow_imports = skip
check_untyped_defs = True
warn_unused_ignores = True
mypy: add --no-strict-optional Since mypy-0.600, validations for Optional becomes very strict. It interfere our development. So this disables it temporarily.
2018-05-02 20:23:34 -05:00
strict_optional = False
travis: Enable codecov coverage This necessitates adding some basic coverage-py configuration [1] and making sure the pytest-cov plugin uses said configuration [2]. Badges are included. Note that we do not run the 'coverage' tox target, which is reserved for users. [1] https://github.com/codecov/example-python [2] https://bitbucket.org/ned/coveragepy/issues/512/ Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-21 09:52:46 -05:00
test: Reduce DeprecationWarning on testing (from docutils)
2018-01-05 22:22:47 -06:00
[tool:pytest]
filterwarnings =
test: Give filterwarnings=all by ini file Since pytest-3.9, precedence order of warning options had been changed. This moves ``-W all`` option into setup.cfg. In detail, see https://github.com/pytest-dev/pytest/issues/3946
2018-10-29 09:59:31 -05:00
all
test: Reduce DeprecationWarning on testing (from docutils)
2018-01-05 22:22:47 -06:00
ignore::DeprecationWarning:docutils.io
refactor: Suppress DeprecationWarning for pyximport
2020-05-03 10:27:38 -05:00
ignore::DeprecationWarning:pyximport.pyximport
refactor: Catch ImportError for lib2to3 to support future python
2020-05-03 11:47:42 -05:00
ignore::PendingDeprecationWarning:sphinx.util.pycompat
test: declare pytest markers To stop PytestUnknownMarkWarning, this declares markers on setup.cfg https://docs.pytest.org/en/latest/mark.html
2019-05-12 01:21:03 -05:00
markers =
apidoc
setup_command
pytest: configure testpaths This avoids having unrelated files being collected.
2020-03-12 10:41:34 -05:00
testpaths = tests
test: Reduce DeprecationWarning on testing (from docutils)
2018-01-05 22:22:47 -06:00
travis: Enable codecov coverage This necessitates adding some basic coverage-py configuration [1] and making sure the pytest-cov plugin uses said configuration [2]. Badges are included. Note that we do not run the 'coverage' tox target, which is reserved for users. [1] https://github.com/codecov/example-python [2] https://bitbucket.org/ned/coveragepy/issues/512/ Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-21 09:52:46 -05:00
[coverage:run]
branch = True
Unpin coverage package coverage-5.0 expects to set "parallel = True" on config file. refs: https://github.com/nedbat/coveragepy/issues/716#issuecomment-429491441
2020-03-05 07:28:35 -06:00
parallel = True
travis: Enable codecov coverage This necessitates adding some basic coverage-py configuration [1] and making sure the pytest-cov plugin uses said configuration [2]. Badges are included. Note that we do not run the 'coverage' tox target, which is reserved for users. [1] https://github.com/codecov/example-python [2] https://bitbucket.org/ned/coveragepy/issues/512/ Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-21 09:52:46 -05:00
source = sphinx
[coverage:report]
exclude_lines =
# Have to re-enable the standard pragma
pragma: no cover
# Don't complain if tests don't hit defensive assertion code:
raise NotImplementedError
# Don't complain if non-runnable code isn't run:
if __name__ == .__main__.:
ignore_errors = True
Reference in New Issue Copy Permalink