Brian Schubert
61f2085687
[3.11] gh-115664: Fix chronological ordering of versionadded and versionchanged directives (GH-115676) ( #115681 )
...
Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
2024-02-19 18:42:19 +00:00
Erlend E. Aasland
eb94a0426f
[3.11] Docs: align usage of versionadded/versionchanged with recommended practice ( #114409 ) ( #114473 )
...
(cherry picked from commit 1d7bddd961
)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 10:39:25 +01:00
Miss Islington (bot)
e16a9af1cd
[3.11] gh-109414: Add some basic information about venvs in the introduction. (GH-109440) (GH-109480)
...
(cherry picked from commit a6846d45ff
)
2023-09-16 11:14:07 +01:00
Serhiy Storchaka
ec8718dd7c
[3.11] gh-106948: Add standard external names to nitpick_ignore (GH-106949) ( #107061 )
...
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH"..
(cherry picked from commit f8b7fe2f26
)
2023-07-23 11:24:37 +02:00
Miss Islington (bot)
d8055b889c
[3.11] Adjust expression from `==` to `!=` in alignment with the meaning of the paragraph. (GH-104021) (GH-104031)
...
(cherry picked from commit 93107aa2a4
)
2023-05-01 06:58:33 +01:00
Hugo van Kemenade
6b6c2f53ec
[3.11] Remove misformatted exclamation marks in docs (GH-102694) ( #102716 )
...
Remove the exclamation mark from :program:`!foo` in .rst files because
it inadvertently shows up in the rendered HTML.
(Sphinx's cross-referencing roles use a '!' prefix to suppress
hyperlinking[1], but :program: is not a cross-referencing role so the
'!' is displayed verbatim.)
The exclamation marks in venv.rst were introduced in #98350 . See
comments [2] and [3] for additional discussion.
[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax
[2]: https://github.com/python/cpython/pull/98350#issuecomment-1285965759
[3]: https://github.com/python/cpython/pull/98350#issuecomment-1286394047
Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Tom Levy <tomlevy93@gmail.com>
2023-03-15 09:25:55 +02:00
Pablo Galindo Salgado
b3cafb60af
[3.11] Fix v3.11.0 release merge problems (GH-98622)
...
When merging the v3.11.0 tag into 3.11, some files were incorrectly updated and some others were not properly deleted.
Automerge-Triggered-By: GH:pablogsal
2022-10-24 16:30:06 -07:00
Pablo Galindo
69b6b56d85
Python 3.11.0
...
-----BEGIN PGP SIGNATURE-----
iQIzBAABCAAdFiEEz9yiRbEEPPKl+Xhl/+h0BBaL2EcFAmNWzOwACgkQ/+h0BBaL
2EcepxAAmZLGMrL4D7Zxzo6N2ezkuiuoQH4JvxIUaB7cjU5h0GSUFlmcJQCHhCwk
AvToQrmH/7uuuEZKST1fomtUE83wudfHhX2t+CMBdbLG1hIwhTfLNMTqFhONturF
XlkVUcva1i9XrYZPLl1pIcBf1Sjm6pPW5QZ4BP1ZHJ5C2pHEzaBRFX/q0lU5aF9O
z5nBBpnga2gShUTqM1VkXucU4lKXsi4blbn/Z8giganMXY1SXIsEOoCaDZYN1Hh/
xQiOpSrjy/uSz4vGSNuPwp9J2lRlw8n4RBd/P7om01CrJMAKotH+62OqwhlQ8ydB
ywp0kygtPtMdSK7F1WKMWkYX4CXfLpYwN0+x3Z3iYFBFiuzOFrUCQYgqqfEPNq+o
bQxxnhAvYcOVINUub6oL23hgFZIoM6l54L66qujQVFM0usCY2f23Ikqd0Z7K8+6e
uDRAvGiCHkbbfhdnfXzc/Wgj4zLaPnNs8S2s8ojK32NPV8gyWVBumcsRvlocfl6K
hoA5wqeAXsOv+pFjkGtk90Yg+8R9n+n47//o6uYW/vvZtksm2wPm3hnuCA0WqPzN
IM7SJE5VrtSRqQpXT9j4G3zyHDNT/Qhrh+cyBM5kgoPSdbU0ugZN8P7GWVtsFhmK
rrHRns85gNZJ6qTN1pU22MybYCPIsg5Dt6+jZ8hJWIzOOy9apIk=
=Ryd2
-----END PGP SIGNATURE-----
gpgsig -----BEGIN PGP SIGNATURE-----
iQIzBAABCAAdFiEEz9yiRbEEPPKl+Xhl/+h0BBaL2EcFAmNW55YACgkQ/+h0BBaL
2EfCLg//bMWtb/X3D+IM+9BIrpEscj/vw22zH9j8PIRd8iWfW80TNEIBh4uPEc0j
SDTkA5bqN6CB7xqIxDlWQcJpGiImVZ2LzOw8HHye1QCfVZk741CF78UhEnb+hTbO
gr7nIznytv+VdMSDRHTSgpnkRNQ9FjFEHLu7YQTMof5i/YmTxWZcsru6dTLlEutg
F3+PfxbKwPgJkfare91X62XSQwyTL6k0mvl5+Sdq2WEQdgMqv4I8V9dHbnk9K3VI
B+K2xsfIyWHrLDwQa3LBZj4YOKTwnwqlr1sEqO47NfasWaMYa1vBsktLVtPVQ3xS
Hz0lLhJXJLzf5hmf2r4Tw1S5spn5ijsZ7CwK2Zl+1+dbJMpRoK4VeSSYy/OfEpwy
8Hx1YitMyORF3HkGWa+pPYPNaIOw4S/EQQPYd5osg3NnknYjkkKZZaliq7EZra7c
GANPJamXhHREQyhux9KeiYZer3SU3CSXopyxm8ClcBZJAiAOjhAdeOk+Q4Ta9T6+
gRWBOrelroyFTWHsOd8V7gSz3XJNuAzlNZ/+1Oj/7Em+5DGLFcxJrZGLxn+hruZ5
GPK9IQXbURAuxqVrqCzw2tzf/NzJr0fs4QDYEVI95pfLjzk1tuJ5WR6zFNC0COK2
qw8TTvXglsvHqVMnK8u73GVSTv1UGYqbQH9uAeEikAQYr3TTdZo=
=dsZm
-----END PGP SIGNATURE-----
Merge tag 'v3.11.0' into 3.11
Python 3.11.0
2022-10-24 20:29:24 +01:00
Miss Islington (bot)
e69136baff
[3.11] gh-88452: Add a warning about non-portability of environments. (GH-98155) (GH-98157)
2022-10-22 20:04:46 +01:00
Vinay Sajip
3b7e0204bf
[3.11] [doc] Refresh the venv introduction documentation, and correct the st… (GH-98465)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Phil Elson <pelson.pub@gmail.com>
2022-10-19 22:28:24 +01:00
Miss Islington (bot)
5c0d4c2619
[3.11] gh-88452: Add a warning about non-portability of environments. (GH-98155) (GH-98157)
2022-10-10 21:10:04 +01:00
Miss Islington (bot)
72cad6cfe5
gh-95451: Update docs for wasm32-emscripten and -wasi platforms (GH-95452)
...
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Michael Droettboom <mdboom@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit e3b6ff19aa
)
Co-authored-by: Christian Heimes <christian@python.org>
2022-08-02 12:13:07 -07:00
Miro Hrončok
48d9262699
bpo-45413: Define "posix_venv", "nt_venv" and "venv" sysconfig installation schemes (GH-31034)
...
Define *posix_venv* and *nt_venv* sysconfig installation schemes
to be used for bootstrapping new virtual environments.
Add *venv* sysconfig installation scheme to get the appropriate one of the above.
The schemes are identical to the pre-existing
*posix_prefix* and *nt* install schemes.
The venv module now uses the *venv* scheme to create new virtual environments
instead of hardcoding the paths depending only on the platform. Downstream
Python distributors customizing the *posix_prefix* or *nt* install
scheme in a way that is not compatible with the install scheme used in
virtual environments are encouraged not to customize the *venv* schemes.
When Python itself runs in a virtual environment,
sysconfig.get_default_scheme and
sysconfig.get_preferred_scheme with `key="prefix"` returns
*venv*.
2022-03-18 10:53:29 +01:00
Arkaprabha Chakraborty
d22a700091
[doc] Add a missing apostrophe in a code example in venv.rst (GH-28391)
2021-09-17 23:08:25 +02:00
Matthew Clapp
4bcef2bb48
bpo-44388: Update venv EnvBuilder.ensure_directories() docs. (GH-26663)
...
Ref:
This changes the documentation for `EnvBuilder.ensure_directories(env_dir)` to match the actual behavior of that API call.
In particular, `ensure_directories()` is not affected by the state of the `upgrade` attribute, and will not cause an error to have existing directories whether or not the `clear` attribute is set.
This documentation change I believe should be valid to all python versions back to 3.6.
Automerge-Triggered-By: GH:vsajip
2021-07-02 13:48:15 -07:00
Mariusz Felisiak
d0a445490e
Update link to Django's Context class. ( #24805 )
...
* Update link to Django's Context class.
* Update link to get-pip.py.
2021-03-13 04:26:11 -08:00
Shantanu
1cba1c9aba
bpo-34556: Document addition of upgrade_deps to venv.create (GH-20135)
2020-05-23 02:58:50 -07:00
Ogi Moore
c4a65ed7fe
bpo-39417: Fix broken link to guide to building venvs (GH-18432)
2020-02-10 15:51:01 -08:00
Vinay Sajip
7d6378051f
bpo-38901: Allow setting a venv's prompt to the basename of the current directory. (GH-17946)
...
When a prompt value of '.' is specified, os.path.basename(os.getcwd()) is used to
configure the prompt for the created venv.
2020-01-14 20:49:30 +00:00
Tzu-ping Chung
045d4e243d
bpo-38928: Fix versionadded for venv's upgrade_deps function (GH-17404)
2019-11-27 20:21:48 +00:00
Serhiy Storchaka
138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
...
* "Return true/false" is replaced with "Return ``True``/``False``"
if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
2019-11-12 16:57:03 +02:00
Vinay Sajip
264e034f99
bpo-37662: Documented venv.EnvBuilder.upgrade_dependencies(). (GH-15768)
2019-09-09 14:50:38 +01:00
Brett Cannon
2f224a077a
Touch up venv docs (GH-14922)
2019-07-23 14:34:32 -07:00
Cooper Lees
4acdbf11b1
bpo-34556: Add --upgrade-deps to venv module ( #13100 )
...
Add --upgrade-deps to venv module
- This allows for pip + setuptools to be automatically upgraded to the latest version on PyPI
- Update documentation to represent this change
bpo-34556: Add --upgrade to venv module
2019-06-17 19:18:13 +01:00
Sebastian Koslowski
3921b1cc34
bpo-36275: enhance documentation for venv.create() (GH-13114)
2019-05-06 14:51:09 -04:00
Steve Dower
a1f9a3332b
bpo-35854: Fix EnvBuilder and --symlinks in venv on Windows (GH-11700)
2019-01-30 13:49:14 -08:00
Steve Dower
1c3de541e6
bpo-34977: Use venv redirector instead of original python.exe on Windows (GH-11029)
2018-12-10 08:11:21 -08:00
Elena Oat
5032692746
bpo-24356: Specify which Python binary will be used with venv (GH-6589)
2018-07-28 13:58:05 +01:00
Vinay Sajip
c0d341d49b
bpo-32519: Removed misleading sentence from EnvBuilder documentation. (GH-7296)
2018-06-01 10:08:33 +01:00
Brett Cannon
a8c342465b
bpo-25427: Remove pyvenv (GH-5962)
2018-04-20 14:15:40 -07:00
Sanyam Khurana
338cd83c5d
bpo-25910: Link redirections in docs ( #1933 )
...
Fixes some redirection links in docs.
2018-01-20 01:25:37 +01:00
Zachary Ware
d9aa4d3308
Merge from 3.5
2016-10-25 21:36:13 -05:00
Zachary Ware
bb444772d9
Fix default role usage
2016-10-25 21:35:22 -05:00
Brett Cannon
68adfa3b3e
Merge (issue #25152 )
2016-10-21 12:54:02 -07:00
Brett Cannon
f8c1505736
Issue #25152 : Mention the deprecation of pyvenv
2016-10-21 12:53:40 -07:00
Vinay Sajip
fd0f84bd8f
Closes #22829 : Added --prompt option to venv.
2016-08-06 10:43:44 +01:00
Brett Cannon
15552c39e0
Issue #27285 : Document the deprecation of the pyvenv script.
...
As part of the update, the documentation was updated to normalize
around the term "virtual environment" instead of relying too heavily
on "venv" for the same meaning and leading to inconsistent usage of
either.
Thanks to Steve Piercy for the patch.
2016-07-08 10:46:21 -07:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Berker Peksag
777d639a92
Issue #21034 : Remove outdated paragraph from venv documentation
...
Since Python 3.4, there is no need to install pip and setuptools
into a venv manually.
2016-03-07 18:50:49 +02:00
Jason R. Coombs
73308d6869
Merge doc change from 3.3
2014-05-12 22:41:15 -04:00
Jason R. Coombs
13266fb5c8
Update docs to reflect resurrection of Setuptools over Distribute
2014-05-12 22:40:49 -04:00
Larry Hastings
3732ed2414
Merge in all documentation changes since branching 3.4.0rc1.
2014-03-15 21:13:56 -07:00
Nick Coghlan
aa029dad50
Tweaks to What's New and some referenced docs
2014-02-09 10:10:24 +10:00
Serhiy Storchaka
0e90e99188
Issue #19795 : Improved markup of True/False constants.
2013-11-29 12:19:53 +02:00
Serhiy Storchaka
fbc1c26803
Issue #19795 : Improved markup of True/False constants.
2013-11-29 12:17:13 +02:00
Nick Coghlan
8fbdb097cf
Close #19552 : venv and pyvenv ensurepip integration
2013-11-23 00:30:34 +10:00
Georg Brandl
93c85a9d1b
merge with 3.3
2013-10-06 12:52:53 +02:00
Georg Brandl
a0b792354e
Fix method name: ensure_directories, not create_directories. Found by Michael Rand on docs@.
2013-10-06 12:52:49 +02:00
Vinay Sajip
dff9e2535f
Closes #19139 : Changed usage of __VENV_NAME__ and added __VENV_PROMPT__.
2013-10-02 11:36:16 +01:00
Vinay Sajip
e2549df82e
Closes #18939 : Merged documentation update from 3.3.
2013-09-06 09:51:27 +01:00