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
d47f38e22d
sphinx/tox.ini

88 lines
2.0 KiB
INI
Raw Normal View History

Add tox.ini.
2010-07-23 04:37:44 -05:00
[tox]
Simplify tox configuration with 'extras' option https://tox.readthedocs.io/en/latest/config.html#conf-extras > extras(MULTI-LINE-LIST) > > New in version 2.4. > > A list of “extras” to be installed with the sdist or develop install. > For example, extras = testing is equivalent to [testing] in a pip > install command.
2018-11-11 11:33:17 -06:00
minversion = 2.4.0
Test with docutils-0.14 (previous release)
2019-07-21 10:35:28 -05:00
envlist = docs,flake8,mypy,coverage,py{35,36,37,38},du{12,13,14,15}
Add tox.ini.
2010-07-23 04:37:44 -05:00
[testenv]
Fix #4378: tox: use usedevelop option instead skipsdist
2018-01-05 07:25:34 -06:00
usedevelop = True
tox: Add documentation for all targets This should make 'tox -av' more helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 09:55:10 -06:00
passenv =
Fix existence check for JRE was broken
2018-03-20 09:35:32 -05:00
https_proxy http_proxy no_proxy PERL PERL5LIB PYTEST_ADDOPTS EPUBCHECK_PATH
tox: Add documentation for all targets This should make 'tox -av' more helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 09:55:10 -06:00
description =
Remove pypy from tox.ini The pypy executable is Python 2 and Python 2 support was dropped in commit 9412bd76b7f5fdf0adc231ef8130e45bda130164.
2018-09-07 18:15:20 -05:00
py{35,36,37,38}: Run unit tests against {envname}.
Drop docutils 0.11 support
2018-08-24 08:01:41 -05:00
du{12,13,14}: Run unit tests with the given version of docutils.
Remove 'test-reqs.txt' We were never really using this file for its specified purpose [1]. Now that we have everything cleanly organized in 'setup.py', there really isn't any reason to keep it around. Remove it. [1] https://caremad.io/posts/2013/07/setup-vs-requirement/ Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-10 08:10:11 -05:00
deps =
CI: Pinning coverage < 5.0
2019-12-15 02:47:57 -06:00
coverage < 5.0 # refs: https://github.com/sphinx-doc/sphinx/pull/6924
tox: Make further use of factor-conditional deps This is how we reduce boilerplate [1]. Succinctness FTW. [1] https://tox.readthedocs.io/en/latest/config.html#factors-and-factor-conditional-settings Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-27 04:11:10 -05:00
du12: docutils==0.12
du13: docutils==0.13.1
du14: docutils==0.14
Test with docutils-0.14 (previous release)
2019-07-21 10:35:28 -05:00
du15: docutils==0.15
test: Testing with docutils-0.16rc1
2019-12-20 20:38:31 -06:00
du16: docutils==0.16rc1
Simplify tox configuration with 'extras' option https://tox.readthedocs.io/en/latest/config.html#conf-extras > extras(MULTI-LINE-LIST) > > New in version 2.4. > > A list of “extras” to be installed with the sdist or develop install. > For example, extras = testing is equivalent to [testing] in a pip > install command.
2018-11-11 11:33:17 -06:00
extras =
test
fix some testing. * Python3 test support * Specify depended library version for Python2.4, 2.5
2012-05-01 01:21:12 -05:00
setenv =
tox: Ignore distutils deprecation warning distutils/__init__.py:4: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses import imp Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-14 16:02:53 -06:00
PYTHONWARNINGS = all,ignore::ImportWarning:pkgutil,ignore::ImportWarning:importlib._bootstrap,ignore::ImportWarning:importlib._bootstrap_external,ignore::ImportWarning:pytest_cov.plugin,ignore::DeprecationWarning:site,ignore::DeprecationWarning:_pytest.assertion.rewrite,ignore::DeprecationWarning:_pytest.fixtures,ignore::DeprecationWarning:distutils
More toxy goodness.
2010-07-23 05:16:17 -05:00
commands=
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
pytest --durations 25 {posargs}
More toxy goodness.
2010-07-23 05:16:17 -05:00
add flake8 testing
2015-03-07 00:45:43 -06:00
[testenv:flake8]
tox: Run everything but unit tests under Python 3 The demise of Python 2.7 is not far off and we intend to drop support for it in Sphinx 2.0. As a result, there probably isn't a better time than now to start testing with Python 3 by default. There are a couple of advantages to this: - flake8 is stricter under Python 3 and we don't need to ignore files with Python 3 syntax - We get to dogfood Sphinx against its own documentation using Python 3 - pylint gains support for Python 3 syntax Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 03:53:29 -05:00
basepython = python3
tox: Add documentation for all targets This should make 'tox -av' more helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 09:55:10 -06:00
description =
Run style checks.
commands =
flake8
Move py3.5 specific tests to their own file and adjust test environment
2015-11-09 20:40:48 -06:00
tox: Add pylint target to tox This isn't enabled by default because it throws so many damn errors. Perhaps we should simply remove this? Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-05 03:16:05 -05:00
[testenv:pylint]
tox: Run everything but unit tests under Python 3 The demise of Python 2.7 is not far off and we intend to drop support for it in Sphinx 2.0. As a result, there probably isn't a better time than now to start testing with Python 3 by default. There are a couple of advantages to this: - flake8 is stricter under Python 3 and we don't need to ignore files with Python 3 syntax - We get to dogfood Sphinx against its own documentation using Python 3 - pylint gains support for Python 3 syntax Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 03:53:29 -05:00
basepython = python3
tox: Add documentation for all targets This should make 'tox -av' more helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 09:55:10 -06:00
description =
Run source code analyzer.
deps =
tox: Add pylint target to tox This isn't enabled by default because it throws so many damn errors. Perhaps we should simply remove this? Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-05 03:16:05 -05:00
pylint
{[testenv]deps}
tox: Add documentation for all targets This should make 'tox -av' more helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 09:55:10 -06:00
commands =
tox: Add pylint target to tox This isn't enabled by default because it throws so many damn errors. Perhaps we should simply remove this? Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-05 03:16:05 -05:00
pylint --rcfile utils/pylintrc sphinx
tox: Report coverage to user Run 'coverage report' after a successful coverage run. There's enough coverage-related stuff here at this point to warrant its own section. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-22 12:00:25 -06:00
[testenv:coverage]
tox: Run everything but unit tests under Python 3 The demise of Python 2.7 is not far off and we intend to drop support for it in Sphinx 2.0. As a result, there probably isn't a better time than now to start testing with Python 3 by default. There are a couple of advantages to this: - flake8 is stricter under Python 3 and we don't need to ignore files with Python 3 syntax - We get to dogfood Sphinx against its own documentation using Python 3 - pylint gains support for Python 3 syntax Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 03:53:29 -05:00
basepython = python3
tox: Report coverage to user Run 'coverage report' after a successful coverage run. There's enough coverage-related stuff here at this point to warrant its own section. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-22 12:00:25 -06:00
description =
Run code coverage checks.
setenv =
PYTEST_ADDOPTS = --cov sphinx --cov-config {toxinidir}/setup.cfg
commands =
{[testenv]commands}
coverage report
tox: Add 'mypy' target Like the recently added 'docs' target, this is easier than creating a virtualenv, installing deps and running make. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-02-28 11:31:31 -06:00
[testenv:mypy]
tox: Run everything but unit tests under Python 3 The demise of Python 2.7 is not far off and we intend to drop support for it in Sphinx 2.0. As a result, there probably isn't a better time than now to start testing with Python 3 by default. There are a couple of advantages to this: - flake8 is stricter under Python 3 and we don't need to ignore files with Python 3 syntax - We get to dogfood Sphinx against its own documentation using Python 3 - pylint gains support for Python 3 syntax Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 03:53:29 -05:00
basepython = python3
tox: Add documentation for all targets This should make 'tox -av' more helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 09:55:10 -06:00
description =
Run type checks.
deps =
tox: Add 'mypy' target Like the recently added 'docs' target, this is easier than creating a virtualenv, installing deps and running make. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-02-28 11:31:31 -06:00
mypy
Add docutils-stubs to test deps
2018-12-03 10:52:07 -06:00
docutils-stubs
tox: Add 'mypy' target Like the recently added 'docs' target, this is easier than creating a virtualenv, installing deps and running make. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-02-28 11:31:31 -06:00
commands=
mypy sphinx/
tox: Add 'docs' target This is easier than creating a virtualenv, installing deps and running make. It also makes explicit use of the setuptool integration that is now documented. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-02-24 12:25:51 -06:00
[testenv:docs]
tox: Run everything but unit tests under Python 3 The demise of Python 2.7 is not far off and we intend to drop support for it in Sphinx 2.0. As a result, there probably isn't a better time than now to start testing with Python 3 by default. There are a couple of advantages to this: - flake8 is stricter under Python 3 and we don't need to ignore files with Python 3 syntax - We get to dogfood Sphinx against its own documentation using Python 3 - pylint gains support for Python 3 syntax Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 03:53:29 -05:00
basepython = python3
tox: Add documentation for all targets This should make 'tox -av' more helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 09:55:10 -06:00
description =
Build documentation.
Add extra requirements for docs (refs: #6336)
2019-05-03 22:42:17 -05:00
extras =
docs
tox: Add documentation for all targets This should make 'tox -av' more helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 09:55:10 -06:00
commands =
tox: Pass posargs to docs This allows us to do something like the following: tox -e docs -- -b man Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-10-03 04:25:10 -05:00
python setup.py build_sphinx {posargs}
Add bindep integration The bindep (BINary DEPendency automation) tool is a tool for checking the presence of binary packages needed to use an application / library. Use it to specify the dependencies needed to successfully pass the LaTex tests. Only Fedora targets are currently provided. Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-19 07:55:17 -06:00
Add utils/doclinter.py; a documenter linter for Sphinx
2019-05-12 03:57:25 -05:00
[testenv:docslint]
basepython = python3
description =
Lint documentation.
extras =
docs
commands =
python utils/doclinter.py CHANGES CONTRIBUTING.rst README.rst doc/
Add bindep integration The bindep (BINary DEPendency automation) tool is a tool for checking the presence of binary packages needed to use an application / library. Use it to specify the dependencies needed to successfully pass the LaTex tests. Only Fedora targets are currently provided. Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-19 07:55:17 -06:00
[testenv:bindep]
description =
Install binary dependencies.
deps =
bindep
commands =
bindep test
Reference in New Issue Copy Permalink