Debian Codegraph @

doc/source/user/compatibility.rst

raw
1 ..
2 The name of this document and the anchor in this document must be
3 treated as a stable API. Links to this document are coded into
4 pbr and deployed versions of pbr will refer users to this document
5 in the case of certain errors.
6 Ensure any link you use in PBR is defined via a ref with .. _name.
7
8
9 ===================
10 Compatibility Notes
11 ===================
12
13 Useful notes about errors users may encounter when features cannot be
14 supported on older versions of setuptools / pip / wheel.
15
16
17 setuptools
18 ==========
19
20
21 .. _evaluate-marker:
22
23 evaluate_marker
24 ---------------
25
26 evaluate_markers may run into issues with the '>', '>=', '<', and '<='
27 operators if the installed version of setuptools is less than 17.1. Projects
28 using these operators with markers should specify a minimum version of 17.1
29 for setuptools.
30
31
32 pip
33 ===
34
35 markers
36 -------
37
38 For versions of pip < 7 with pbr < 1.9, dependencies that use markers will not
39 be installed. Projects using pbr and markers should set a minimum version of
40 1.9 for pbr.
41
42
43 Recommended setup.py
44 ====================
45
46 :ref:`setup_py`.
47
48
49 Sphinx
50 ======
51
52 .. _sphinx-1.5:
53
54 Version 1.5.0+
55 --------------
56
57 The ``warning-is-error`` flag is only supported by Sphinx 1.5 and will cause
58 errors when used with older versions.