Commit Graph

26359 Commits

Author SHA1 Message Date
Miss Islington (bot) f106254e0b
[3.11] Bump some docs dependencies to resolve a Dependabot security alert (GH-107341) (#107343)
Bump some docs dependencies to resolve a Dependabot security alert (GH-107341)
(cherry picked from commit f84d77b4e0)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-07-27 12:15:06 +00:00
Miss Islington (bot) 8f0dc1878c
[3.11] gh-106996: Rewrite turtle explanation (GH-107244) (#107336)
Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-27 08:12:17 +00:00
Serhiy Storchaka 9513acf737
[3.11] gh-107298: Docs: add targets for some :c:member: and :c:macro: references (GH-107316) (GH-107333)
Add targets for PyStructSequence_Desc and PyStructSequence_Field members
and macros like Py_EQ.
Fix target for Py_RETURN_RICHCOMPARE.
(cherry picked from commit abec9a1b20)
2023-07-27 09:27:02 +03:00
Serhiy Storchaka 17aada0dd0
[3.11] gh-107091: Fix some uses of :attr: role (GH-107318) (GH-107331)
Fix also formatting of PyMethodDef members.
(cherry picked from commit d363eb5b02)
2023-07-27 09:26:14 +03:00
Erlend E. Aasland 00b65da493
[3.11] Docs: Argument Clinic: Restructure "Basic concepts and usage" (#106981) (#107327)
Split "Basic concepts and usage" into:

- Reference
  - Terminology
  - CLI reference

- Background
  - Basic concepts

(cherry picked from commit 2ad699002e)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-27 01:26:04 +02:00
Erlend E. Aasland 55edee247c
[3.11] Docs: Remove the numbered steps from the Argument Clinic tutorial (#107203) (#107319)
Instead, order the tutorial as one body of prose, making it easier to
align the tutorial according to Diátaxis principles.

(cherry picked from commit 592395577c)
2023-07-26 21:21:28 +00:00
Miss Islington (bot) 603c5d50e8
[3.11] gh-107091: Fix some uses of :c:type: role (GH-107138) (GH-107313)
(cherry picked from commit 6d5b6e71c8)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-27 00:00:36 +03:00
Miss Islington (bot) 35aa6b80a6
[3.11] Document that `os.link()` is not available on Emscripten (GH-104822) (GH-107309)
Document that `os.link()` is not available on Emscripten (GH-104822)
(cherry picked from commit 737d1da074)

Co-authored-by: Roman Yurchak <rth.yurchak@gmail.com>
2023-07-26 13:00:13 -07:00
Serhiy Storchaka cfa9f3b7cc
[3.11] gh-107091: Fix some uses of :c:member: role (GH-107129) (GH-107311)
(cherry picked from commit af61cb9c78)
2023-07-26 19:35:16 +00:00
Victor Stinner bd0def00b3
[3.11] gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295) (#107299)
gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295)

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit b1de3807b8)
2023-07-26 16:27:08 +00:00
Wei-Hsiang (Matt) Wang 9fa44d7a30
[3.11] GH-97950: Fix old-style index directive in Doc/library/imp.rst (#107246)
Use new-style index directive ('statement') - library/imp
2023-07-26 08:17:44 +03:00
Miss Islington (bot) 5a89248696
[3.11] gh-106939: document ShareableList nul-strip quirk. (GH-107266) (#107270)
gh-106939: document ShareableList nul-strip quirk. (GH-107266)

* gh-106939: document ShareableList nul-strip quirk.
* Mention the `int` size constraint.
(cherry picked from commit 70dc009469)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-07-25 21:18:23 +00:00
Miss Islington (bot) 012bc1329a
[3.11] Remove superflous whitespaces in `layout.html`. (GH-107251) (#107252)
Remove superflous whitespaces in `layout.html`. (GH-107251)

Remove superflous whitespaces in layout.html.
(cherry picked from commit 313284aa42)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-25 16:34:56 +00:00
Miss Islington (bot) 1bc160947e
[3.11] gh-106996: Add a how-to section to the turtle documentation (GH-107153) (#107234)
Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-25 12:17:14 +00:00
Miss Islington (bot) 8725d36fda
[3.11] gh-107017: Change Chapter Strings to Texts in the Introduction chapter. (GH-107104) (#107168)
Co-authored-by: TommyUnreal <45427816+TommyUnreal@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-24 16:39:43 +00:00
Erlend E. Aasland 604eb04059
[3.11] Docs: Add missing markup to Argument Clinic docs (#106876) (#107182)
(cherry picked from commit ff5f94b72c)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-24 15:45:13 +00:00
Miss Islington (bot) 579868e8f1
[3.11] Fix PyVectorcall_Function doc versionadded (GH-107140) (#107174)
Fix PyVectorcall_Function doc versionadded (GH-107140)

The documentation implies that PyVectorcall_Function() was available in Python 3.8.
This is half-true - it was available under a different name. I think it's clearer to set
the "version added" to 3.9.
(cherry picked from commit 0a9b339363)

Co-authored-by: da-woods <dw-git@d-woods.co.uk>
2023-07-24 13:06:46 +00:00
Miss Islington (bot) 798d83bec8
[3.11] Docs: Remove duplicate word in Argument Clinic howto heading (GH-107169) (#107172)
(cherry picked from commit ebe44a5155)

Co-authored-by: Hakan Celik <hakancelikdev@gmail.com>
2023-07-24 12:06:06 +00:00
Erlend E. Aasland b3e600a632
[3.11] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (#107062) (#107157)
(cherry picked from commit b447e19e72)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 23:49:48 +02:00
Miss Islington (bot) 6138ecdeb8
[3.11] gh-107017: Analolgy to Pascal and C replaced. (GH-107025) (#107123)
Co-authored-by: TommyUnreal <45427816+TommyUnreal@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-23 13:59:05 +00:00
Serhiy Storchaka d2cdf0888b
[3.11] gh-107091: Fix the use of some C domain roles (GH-107092) (GH-107121)
(cherry picked from commit 08a228da05)
2023-07-23 15:06:32 +03:00
wulmer c51f766ebb
[3.11] gh-101100: Fix some broken sphinx references (GH-107095). (#107120) 2023-07-23 05:56:09 -06:00
Moritz Neeb 0574873e60
[3.11] gh-106969: Indicate no modules were added in 3.10 (GH-106988) (#107093)
[3.11] gh-106969: Indicate no modules were added in 3.10 & 3.12 (GH-106988)

The "New Modules" section was left in place to ensure that the anchor
link for new modules will still exist:

/whatsnew/3.12.htmlGH-new-modules
/whatsnew/3.10.htmlGH-new-modules

This means that existing links to this section don't break..
(cherry picked from commit 6dbffaed17)

Co-authored-by: Sebastiaan Zeeff <33516116+SebastiaanZ@users.noreply.github.com>
2023-07-23 12:26:12 +02:00
Daniele Procida 6e3a2fb0fe
[3.11] gh-106996: Add the basics of a turtle graphics tutorial (GH-107072) (#107110) 2023-07-23 04:25:23 -06: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) 65e40aaed0
[3.11] gh-54738: Add argparse i18n howto (GH-104562) (#107101)
(cherry picked from commit dcd7acb04a)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2023-07-23 11:23:51 +02:00
Miss Islington (bot) 5575b1204b
[3.11] gh-71261: Add paragraph on shadowing submodules with star imports (GH-107004) (#107099)
Co-authored-by: wulmer <wulmer@users.noreply.github.com>
2023-07-23 03:12:52 -06:00
Miss Islington (bot) 7d414873b3
[3.11] gh-107017: removed mention that C does it the same way (GH-107020) (#107098)
Co-authored-by: Jakub Červinka <cervinka.jakub.1989@gmail.com>
2023-07-23 03:11:35 -06:00
Miss Islington (bot) 9875b177a9
[3.11] gh-107028: tiny textual changes in logging docs and docstrings (GH-107029) (GH-107066)
(cherry picked from commit 5e5a34ac3a)
2023-07-22 22:12:06 +01:00
Miss Islington (bot) 2895dbd0f6
[3.11] gh-83006: Document behavior of `shutil.disk_usage` for non-mounted filesystems on Unix (GH-107031) (#107048)
(cherry picked from commit 6e5f2235f3)

Co-authored-by: Matthieu Caneill <matthieucan@users.noreply.github.com>
2023-07-22 20:25:15 +02:00
Miss Islington (bot) e5d2a19ac5
[3.11] gh-107008: Document the curses module variables LINES and COLS (GH-107011) (GH-107058)
LINES and COLS referred in curses.update_lines_cols() documentations are
the module variables, not the environment variables.
(cherry picked from commit 26e08dfdd7)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-22 21:13:38 +03:00
wulmer b71144193b
[3.11] Fix Sphinx warnings in `re` module docs (GH-107044). (#107055)
(cherry picked from commit 149748ea4f)
2023-07-22 17:39:46 +01:00
Miss Islington (bot) c332117b52
gh-106847: Add -X warn_default_encoding in sys.flags Doc (GH-106854)
gh-106847: Add -X warn_default_encoding in sys.flags Doc (GH-106854)
(cherry picked from commit fd84ac0ee0)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-07-23 01:23:31 +09:00
Miss Islington (bot) 755166e864
[3.11] gh-105090: Replace incorrect TLSv1.2 with TLSv1.3 (GH-105404) (#107038)
Co-authored-by: Jocelyn Castellano <admin@malwarefight.gq>
2023-07-22 14:29:54 +00:00
Łukasz Langa c65ca7097a
[3.11] Reformat code block to make it easier to read (GH-106965) (#107022)
(cherry picked from commit ed491d9f78)

Co-authored-by: Joe Kaufeld <opensource@joekaufeld.com>
2023-07-22 16:14:24 +02:00
Oliver Rew a7a973e9c7
[3.11] gh-100700 Remove Date and Release fields in past whatsnews (GH-100728) (#106999)
Co-authored-by: Zachary Ware <zach@python.org>
2023-07-22 12:43:43 +00:00
Sebastiaan Zeeff 4f7c23e4df
[3.11] Change non-integral to non-integer in random docs (GH-106975) (#106985) 2023-07-22 02:37:16 -06:00
Serhiy Storchaka b338ac7540
[3.11] gh-106909: Use role :const: for referencing module constants (GH-106910) (GH-106957)
(cherry picked from commit 4b9948617f)
2023-07-21 14:49:57 +03:00
Serhiy Storchaka cc76113cf8
[3.11] gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894) (GH-106955)
(cherry picked from commit d036db728e)
2023-07-21 14:49:21 +03:00
Serhiy Storchaka 6bde1b9f04
[3.11] gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) (GH-106952)
(cherry picked from commit fcc816dbff)
2023-07-21 14:48:30 +03:00
Miss Islington (bot) 0a57620887
[3.11] Docs: Argument Clinic: Add Background and Tutorial top-level sections (GH-106904) (#106946)
Add Background as a toplevel section with the following subsections:

- Background
  - The goals of Argument Clinic
  - Basic concepts and usage

Rename "Converting your first function" to Tutorial.

Add anchors for Background, Tutorial, and How-to Guides:

- :ref:`clinic-background`
- :ref:`clinic-tutorial`
- :ref:`clinic-howtos`

Link to these from within the Abstract.

Break the compatibility paragraph out of Abstract and make it a note.
(cherry picked from commit 81861fd90b)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-21 08:32:56 +02:00
Miss Islington (bot) a5c8d240c0
[3.11] Fix typo in tkinter docs (GH-106936) (#106938)
Fix typo in tkinter docs (GH-106936)
(cherry picked from commit 60e83968d5)

Signed-off-by: Makonede <61922615+Makonede@users.noreply.github.com>
Co-authored-by: Makonede <61922615+Makonede@users.noreply.github.com>
2023-07-21 00:12:00 +01:00
Miss Islington (bot) a6313d78f2
[3.11] gh-106882: Note that `asyncio.Server` is only publicly exposed on 3.11+ (GH-106901) (#106903)
gh-106882: Note that `asyncio.Server` is only publicly exposed on 3.11+ (GH-106901)

And later versions of 3.10, 3.9
(cherry picked from commit 1e1f4e91a9)

Co-authored-by: Jack Nelson <jack@jacknelson.xyz>
2023-07-19 21:03:44 +01:00
Miss Islington (bot) 0c47ed7bbf
[3.11] Docs: Argument Clinic: Group guides about default values (GH-106872) (#106873)
Docs: Argument Clinic: Group guides about default values (GH-106872)

Previous ToC layout (excerpt):

    - How to use symbolic default values
    ...
    - How to assign default values to parameter
      - How to use the ``NULL`` default value
      - How to use expressions as default values

New layout:

    - How to assign default values to parameter
      - The ``NULL`` default value
      - Symbolic default values
      - Expressions as default values

(cherry picked from commit 505eede38d)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-07-19 01:16:04 +02:00
Miss Islington (bot) 38553442c8
[3.11] Docs: Normalise Argument Clinic advanced topics headings (GH-106842) (#106852)
(cherry picked from commit 4cb0b9c0a9)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-07-18 12:25:25 +02:00
Miss Islington (bot) 6193f783d0
[3.11] gh-106780: Add __match_args__ to tutorial example (GH-106784) (#106820)
Add Point definition with this attribute before example
that needs it.
(cherry picked from commit 7aa89e505d)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-07-17 04:15:52 -04:00
Miss Islington (bot) 9532f0e6dd
Doc: fix section levels of devmode doc (GH-106801)
Doc: fix section levels of devmode doc (GH-106801)
(cherry picked from commit e58960160f)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2023-07-16 21:27:51 +09:00
Inada Naoki 77104f5511
Doc: devmode: add -Xdev option to example (GH-106253)
(cherry picked from commit 83bd568d2b)

Co-authored-by: Simone Rubino <daemo00@gmail.com>
2023-07-16 11:43:56 +00:00
Miss Islington (bot) 501178ac9d
[3.11] Docs search: Replace jQuery with vanilla JavaScript (GH-106743) (#106803)
Docs search: Replace jQuery with vanilla JavaScript (GH-106743)

* Replace jQuery with vanilla JavaScript
* Switch 'var' to 'const' or 'let'
(cherry picked from commit c02ee45031)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-16 11:38:46 +03:00
Miss Islington (bot) c73f9c045e
[3.11] Docs: Normalize Argument Clinic How-To section capitalization (GH-106788) (#106792)
(cherry picked from commit 8c17729489)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-07-16 00:50:43 +02:00