Skip to content

gh-139707: Add docs for optional modules - #140171

Merged
encukou merged 19 commits into
python:mainfrom
encukou:optional-module-docs
Nov 6, 2025
Merged

gh-139707: Add docs for optional modules#140171
encukou merged 19 commits into
python:mainfrom
encukou:optional-module-docs

Conversation

@encukou

@encukouencukou commented Oct 15, 2025•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

@bedevere-appbedevere-appBot added docs Documentation in the Doc dir skip news labels Oct 15, 2025
@bedevere-appbedevere-appBot mentioned this pull request Oct 15, 2025
Closed
@encukou@StanFromIreland
Fix ReST syntax
9f2c9e5
... And add Stan as contributor:
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
StanFromIreland
StanFromIreland reviewed Oct 15, 2025
View reviewed changes
Comment threadDoc/using/unix.rst
Comment threadDoc/glossary.rst Outdated
@StanFromIreland

StanFromIreland commented Oct 15, 2025

Copy link
Copy Markdown
Member

pre-commit install is handy :-)

hugovk
hugovk reviewed Oct 15, 2025
View reviewed changes
Comment threadDoc/using/configure.rst Outdated
Comment threadDoc/using/configure.rst Outdated
vstinner
vstinner reviewed Oct 16, 2025
View reviewed changes
Comment threadDoc/library/zlib.rst
Comment threadDoc/using/configure.rst Outdated
encukouand others added 4 commits October 22, 2025 16:13
@encukou@StanFromIreland@hugovk
Apply suggestions from code review
145f0fc
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@encukou
Adjust for libmpdec change
cd7b042
@encukou
Add and cross-link notes in optional module docs
2f91ce5
@encukou
Merge in the main branch
12bf464
@encukou
encukou marked this pull request as ready for review October 22, 2025 14:47
StanFromIreland
StanFromIreland reviewed Oct 22, 2025
View reviewed changes
Comment threadDoc/includes/optional-module.rst Outdated
Comment threadDoc/library/idle.rst
Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/zipfile.rst Outdated
Comment threadDoc/library/zlib.rst Outdated
Comment threadDoc/library/zlib.rst
Comment threadDoc/using/configure.rst Outdated
Comment threadDoc/using/configure.rst Outdated
Comment threadDoc/using/configure.rst
Comment threadDoc/glossary.rst Outdated
encukouand others added 2 commits October 23, 2025 09:03
@encukou@StanFromIreland
Apply suggestions from code review
644a7d5
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@encukou@StanFromIreland
Apply suggestions from code review
88dc122
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
terryjreedy
terryjreedy reviewed Oct 25, 2025
View reviewed changes
Comment threadDoc/library/idle.rst

* configuration, browsers, and other dialogs

.. include:: ../includes/optional-module.rst

@terryjreedyterryjreedyOct 25, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the appropriate place for this, rather than buried in the idlelib entry at the end. Possible suggestion to make the include fit even better.

Suggested change
.. include:: ../includes/optional-module.rst
The IDLE application is implemented in the idlelib package.
.. include:: ../includes/optional-module.rst

with idlelib linked to the entry at the end of the file. OR I could do in a separate PR.

I am also considering adding ":mod: idlelib and " to the beginning of the title in a separate issue. Would have to look at the result, including indexing.

@encukouencukouNov 5, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I added this suggestion.

encukouand others added 5 commits November 5, 2025 12:36
vstinner
vstinner approved these changes Nov 5, 2025
View reviewed changes

@vstinnervstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Comment threadDoc/using/configure.rst Outdated
Comment threadDoc/using/configure.rst Outdated
@encukou@vstinner
Apply suggestions from code review
45f4ec3
Co-authored-by: Victor Stinner <vstinner@python.org>
StanFromIreland
StanFromIreland approved these changes Nov 5, 2025
View reviewed changes

@StanFromIrelandStanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two little nits, otherwise LGTM.

Comment threadDoc/using/unix.rst Outdated
Comment threadDoc/using/configure.rst Outdated
@encukou@StanFromIreland
Apply suggestions from code review
66ac795
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@encukou
encukou merged commit d2ce6d7 into python:mainNov 6, 2025
28 checks passed
@github-project-automationgithub-project-automationBot moved this from Todo to Done in Docs PRsNov 6, 2025
@encukou
encukou deleted the optional-module-docs branch November 6, 2025 10:49
@encukouencukou added the needs backport to 3.14 bugs and security fixes label Nov 6, 2025
@miss-islington-app

miss-islington-appBot commented Nov 6, 2025

Copy link
Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-appBot commented Nov 6, 2025

Copy link
Copy Markdown

Sorry, @encukou, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker d2ce6d708a9eaac4e546744ca4da359ee6901ebc 3.14

@bedevere-app

bedevere-appBot commented Nov 7, 2025

Copy link
Copy Markdown

GH-141204 is a backport of this pull request to the 3.14 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.14 bugs and security fixes label Nov 7, 2025
StanFromIreland added a commit to StanFromIreland/cpython that referenced this pull request Nov 7, 2025
@encukou@StanFromIreland
@hugovk@emmatyping@terryjreedy@vstinner
[3.14]pythongh-139707: Add docs for optional modules (pythonGH-140171)
b73cb36
(cherry picked from commit d2ce6d7)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Emma Smith <emma@emmatyping.dev>
Co-authored-by: Author: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Victor Stinner <vstinner@python.org>
encukou added a commit that referenced this pull request Nov 10, 2025
@StanFromIreland@encukou
@hugovk@emmatyping@terryjreedy@vstinner
[3.14]gh-139707: Add docs for optional modules (GH-140171) (GH-141204)
c12a0be
(cherry picked from commit d2ce6d7)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Emma Smith <emma@emmatyping.dev>
Co-authored-by: Author: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Victor Stinner <vstinner@python.org>
StanFromIreland added a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
@encukou@StanFromIreland
@hugovk@emmatyping@terryjreedy@vstinner
pythongh-139707: Add docs for optional modules (pythonGH-140171)
1d8bbf1
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Emma Smith <emma@emmatyping.dev>
Co-authored-by: Author: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Victor Stinner <vstinner@python.org>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovkhugovkhugovk left review comments
@terryjreedyterryjreedyterryjreedy left review comments
@ZeroIntensityZeroIntensityZeroIntensity left review comments
@vstinnervstinnervstinner approved these changes
@StanFromIrelandStanFromIrelandStanFromIreland approved these changes
@ethanfurmanethanfurmanAwaiting requested review from ethanfurmanethanfurman is a code owner
@berkerpeksagberkerpeksagAwaiting requested review from berkerpeksag
@erlend-aaslanderlend-aaslandAwaiting requested review from erlend-aaslanderlend-aasland is a code owner
@pfmoorepfmooreAwaiting requested review from pfmoorepfmoore is a code owner
@pradyunsgpradyunsgAwaiting requested review from pradyunsgpradyunsg is a code owner
@gpsheadgpsheadAwaiting requested review from gpsheadgpshead is a code owner
@picnixzpicnixzAwaiting requested review from picnixzpicnixz is a code owner
@corona10corona10Awaiting requested review from corona10corona10 is a code owner
@AA-TurnerAA-TurnerAwaiting requested review from AA-TurnerAA-Turner is a code owner
@emmatypingemmatypingAwaiting requested review from emmatypingemmatyping is a code owner
+1 more reviewer
@ShakacroShakacroShakacro approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@encukouencukou

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@encukou@StanFromIreland@vstinner@hugovk@emmatyping@terryjreedy@ZeroIntensity@Shakacro