Commit graph

1117 commits

Author SHA1 Message Date
Hugo van Kemenade
fc657d0c60
[3.11] gh-101100: Fix Sphinx reference warnings (GH-112416) (#112422) 2023-11-26 05:22:17 -07:00
Hugo van Kemenade
d9254f9f04
[3.11] gh-101100 : Fix Sphinx warnings in library/doctest.rst (GH-112399) (#112404)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-11-25 12:26:05 -07:00
Miss Islington (bot)
cfdcc96aba
[3.11] gh-111625: Fix link to Info-ZIP homepage (GH-111626) (#111640)
Co-authored-by: partev <petrosyan@gmail.com>
2023-11-02 11:36:35 +00:00
Miss Islington (bot)
a10fc6670b
[3.11] gh-101100: Fix sphinx warnings in library/asyncio-eventloop.rst (GH-111222) (#111470)
gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222)

* gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst



* Update asyncio-eventloop.rst

* Update socket.rst

---------

(cherry picked from commit 46389c3275)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-29 19:39:25 +00:00
Miss Islington (bot)
bf41dcda70
[3.11] gh-101100: Fix Sphinx warnings for fileno (GH-111118) (#111227)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-23 19:18:00 +00:00
Miss Islington (bot)
aaa755dd48
[3.11] gh-101100: Fix sphinx warnings in library/asyncio-dev.rst (GH-111179) (#111186)
gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst` (GH-111179)

* gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst`

* Update Doc/library/asyncio-eventloop.rst

* Update Doc/library/asyncio-eventloop.rst

---------

(cherry picked from commit 8c689c9b88)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-10-22 10:29:06 -07:00
Miss Islington (bot)
d0502a9c67
[3.11] gh-101100: Fix Sphinx warning in tutorial/introduction.rst (GH-111173) (#111176)
gh-101100: Fix Sphinx warning in `tutorial/introduction.rst` (GH-111173)
(cherry picked from commit 663cf513b0)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
2023-10-22 12:03:39 +00:00
Miss Islington (bot)
6df935c212
[3.11] gh-101100: Fix sphinx warnings in library/codecs.rst (GH-110979) (#111071)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-20 11:09:23 +03:00
Miss Islington (bot)
f1dbde0d3a
[3.11] gh-101100: Fix Sphinx warnings in library/tty.rst (GH-111079) (#111098)
gh-101100: Fix Sphinx warnings in `library/tty.rst` (GH-111079)

Fix Sphinx warnings in library/tty.rst
(cherry picked from commit c42c68aa7b)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-20 07:50:17 +03:00
Miss Islington (bot)
4fc5352a0d
[3.11] gh-101100: Fix sphinx warnings in library/getpass.rst (GH-110461) (#111072)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-19 18:31:29 +03:00
Miss Islington (bot)
44558a9ba8
[3.11] gh-101100: Fix sphinx warnings in library/time.rst (GH-110862) (#110878)
gh-101100: Fix sphinx warnings in `library/time.rst` (GH-110862)
(cherry picked from commit 12deda7633)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-14 14:28:23 +00:00
Miss Islington (bot)
2d615e1c26
[3.11] gh-101100: Fix sphinx warnings in usage/cmdline.rst (GH-110841) (#110856)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-14 00:28:52 -06:00
Miss Islington (bot)
de62c2c1b3
[3.11] gh-101100: Fix sphinx warnings in library/socketserver.rst (GH-110207) (GH-110624)
(cherry picked from commit 756062b296)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-10 14:10:33 +02:00
Miss Islington (bot)
00da3ccd0a
[3.11] gh-101100: Fix sphinx warnings in library/site.rst (GH-110144) (#110185)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-01 11:47:06 -06:00
Miss Islington (bot)
58ac0ed093
[3.11] gh-101100: Fix Sphinx warnings in tutorial/controlflow.rst (GH-109424) (#110085)
Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-29 08:36:24 +00:00
Hugo van Kemenade
6bc722df2e
[3.11] gh-101100: Fix sphinx warnings in library/difflib.rst (GH-110074) (#110082)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-29 11:19:34 +03:00
Miss Islington (bot)
cb0f41f232
[3.11] gh-101100: Fix sphinx warnings in library/devmode.rst (GH-109963) (#109967)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-09-27 17:16:01 +03:00
Miss Islington (bot)
c485715ba8
[3.11] gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) (#109938)
gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931)
(cherry picked from commit 3538930d87)

Co-authored-by: Victor Stinner <vstinner@python.org>
2023-09-27 02:35:26 +02:00
Miss Islington (bot)
3ab0621db7
[3.11] gh-101100: Fix Sphinx warnings in Doc/library/weakref.rst (GH-109881) (#109883)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-26 10:58:59 +03:00
Miss Islington (bot)
e6a9cbd114
[3.11] gh-101100: Fix sphinx warnings in Doc/library/xml.etree.elementtree.rst (GH-109799) (#109801)
gh-101100: Fix sphinx warnings in `Doc/library/xml.etree.elementtree.rst` (GH-109799)
(cherry picked from commit 649768fb67)


gh-101100: Fix shpinx warnings in `Doc/library/xml.etree.elementtree.rst`

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-24 10:02:07 +00:00
Miss Islington (bot)
8e23cd0bbb
[3.11] gh-101100: Fix sphinx warnings in turtle.rst (GH-109394) (#109417)
(cherry picked from commit 21e80f4c19)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-14 14:41:26 -04:00
Miss Islington (bot)
2a24328db5
[3.11] GH-104395: Add a link in 'Meta Information' to the docs download page (GH-104443) (#109346)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-12 20:41:39 +00:00
Nikita Sobolev
662d236be2
[3.11] gh-101100: Fix sphinx warnings in unittest.mock-examples.rst (GH-108810) (#108812)
(cherry picked from commit 5141b1ebe0)
2023-09-02 13:38:59 +00:00
Miss Islington (bot)
fa8b9c147d
[3.11] gh-101100: Fix sphinx warnings in uuid.rst (GH-108805) (#108808)
(cherry picked from commit 21da4980f5)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-09-02 07:05:07 -06:00
Miss Islington (bot)
d3476dcb84
[3.11] gh-101100: Fix sphinx warnings in tutorial/appendix.rst (GH-108750) (#108757)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-01 15:09:43 +03:00
Miss Islington (bot)
3b14346899
[3.11] gh-101100: Fix sphinx warnings in tutorial/classes.rst (GH-108746) (#108755)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-01 10:57:30 +00:00
Miss Islington (bot)
e93f57208f
[3.11] gh-101100: Fix sphinx warnings in threading.rst (GH-108684) (#108708)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-31 11:28:47 +03:00
Miss Islington (bot)
f8ab9751da
[3.11] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) (#108681)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-30 15:19:44 +03:00
Miss Islington (bot)
07c727e92a
[3.11] gh-107136: Remove Plausible for docs metrics (GH-107856) (#108335)
(cherry picked from commit fc23f34cc9)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-23 11:01:30 +02:00
Miss Islington (bot)
fadf8a032b
[3.11] Clarify how topics.py gets created. (GH-106121) (GH-106580)
When changing docs, it was easy to find text in topics.py, and I
wondered whether I was supposed to edit it.  Thankfully, the top of the
file says it's auto-generated, so I knew I didn't have to edit it. But I
didn't know what started the auto-generation process.

It's part of the release process, so I'll leave a note here for future
editors.
(cherry picked from commit dac1e36490)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2023-08-22 19:23:55 +00:00
Serhiy Storchaka
3ca9264aba
[3.11] gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258) (#108290)
(cherry picked from commit d7202e4879)
2023-08-22 20:33:07 +02:00
Miss Islington (bot)
80c7ae00f1
[3.11] gh-107298: Fix C API datetime documentation (GH-108034) (#108233)
(cherry picked from commit d63972e289)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-22 20:32:48 +02:00
Miss Islington (bot)
3a39e15179
[3.11] Resolve reference warnings in faq/gui.rst (GH-108147) (#108194)
(cherry picked from commit 8f3d09bf5d)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-22 20:32:16 +02:00
Serhiy Storchaka
be99653080
[3.11] Improve references in the tutorial (GH-108069) (GH-108204)
* Use full qualified names for references (even if they do not work now,
  they will work in future).
* Silence references to examples.
(cherry picked from commit 622ddc4167)
2023-08-21 10:53:36 +00:00
Miss Islington (bot)
4be05aab33
[3.11] Resolve reference warnings in faq/library.rst (GH-108149) (#108183)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-20 13:26:01 -06:00
Adam Turner
ff82da17b6
[3.11] Resolve reference warnings in faq/design.rst (GH-108148) (#108181) 2023-08-20 18:56:14 +00:00
Erlend E. Aasland
e5e87f2306
[3.11] Docs: Fix Sphinx warnings in logging.rst (GH-108139) (#108175)
(cherry picked from commit c735e79afb)

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-20 16:40:57 +00:00
Erlend E. Aasland
797e3c9e4e
[3.11] Docs: Fix Sphinx warnings in license.rst (#108142) (#108176)
(cherry picked by commit 4d4393139f)

- Fix links to stdlib modules
- Silence links to external functions
2023-08-20 16:27:44 +00:00
Miss Islington (bot)
bc055a21cc
[3.11] Resolve reference warnings in faq/programming.rst (GH-108150) (#108171)
Resolve reference warnings in faq/programming.rst (GH-108150)
(cherry picked from commit a390ec20f5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 14:01:24 +00:00
Miss Islington (bot)
5af34d2a4e
[3.11] Docs: Fix Sphinx warnings in sys.rst (GH-108106) (#108166)
Docs: Fix Sphinx warnings in sys.rst (GH-108106)

- Mark up named tuple attributes as attributes
- Remove links for external functions
- io.BufferedIOBase has no 'buffer' attribute;
  remove the link and mark up using :attr:`!buffer`
- (Re)format some tables as bullet lists:
  - sys._emscripten_info
  - sys.hash_info
  - sys.int_info
  - sys.thread_info
- In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes',
  add links to the frame objects reference.

(cherry picked from commit 29fa7afef9)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 19:22:44 +05:30
Miss Islington (bot)
b389939be9
[3.11] Docs: Fix Sphinx warnings in io.rst (GH-107903) (#108094)
- Mark up parameter and argument names properly
- If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc.

(cherry picked from commit 5c76899dad)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-17 19:29:10 +00:00
Miss Islington (bot)
4e5dac1fe1
[3.11] gh-107298: Fix C API Buffer documentation (GH-108011) (#108041)
gh-107298: Fix C API Buffer documentation (GH-108011)
(cherry picked from commit c2941cba7a)

Co-authored-by: Victor Stinner <vstinner@python.org>
2023-08-16 22:32:17 +02:00
Miss Islington (bot)
0aa3b9d76c
[3.11] GH-84435: Make pyspecific directives translatable (GH-19470) (#107682)
GH-84435: Make pyspecific directives translatable (GH-19470)
(cherry picked from commit ecb05e0b98)

Co-authored-by: cocoatomo <cocoatomo77@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-08 12:17:28 +02:00
Miss Islington (bot)
2345a8fb0c
[3.11] Do not use deprecated `logger.warn()` in pyspecific (GH-107694) (#107696)
Do not use deprecated ``logger.warn()`` in pyspecific (GH-107694)
(cherry picked from commit 9564e31cbc)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-06 14:06:16 +00:00
Miss Islington (bot)
6a2f981418
[3.11] Docs: Only include Plausible for html, not for epub etc (GH-107637) (#107643)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-04 13:11:42 -06:00
Miss Islington (bot)
3c1bcae075
[3.11] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107418)
(cherry picked from commit f2d07d3289)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-29 09:17:20 +03:00
Miss Islington (bot)
c3432523d1
[3.11] gh-107091: Fix some uses of :const: role (GH-107379) (GH-107385)
It is for references, not for literals.
(cherry picked from commit 0aa58fa7a6)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-28 10:36:19 +00:00
Serhiy Storchaka
d9392c0c0a
[3.11] gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) (GH-107381)
(cherry picked from commit 983305268e)
2023-07-28 08:31:49 +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)
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