gh-154753: Fix doc references to moved Platforms/ paths and removed files#154754
Open
ZayanKhan-12 wants to merge 7 commits into
Open
gh-154753: Fix doc references to moved Platforms/ paths and removed files#154754ZayanKhan-12 wants to merge 7 commits into
ZayanKhan-12 wants to merge 7 commits into
Conversation
The Android build tooling moved from Android/ to Platforms/Android/ in pythongh-146445, but the five :source: references in Doc/using/android.rst still point at the old location and render as broken GitHub links. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The iOS build tooling moved to Platforms/Apple in pythongh-146445, with the shared testbed now at Platforms/Apple/testbed rather than under iOS/. Update the :source: references and the example testbed invocation to match (the invocation upstream README uses at Platforms/Apple/iOS/README.md). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
iOS/README.rst moved to Platforms/Apple/iOS/README.md (and became Markdown along the way); the old :source: reference renders as a broken GitHub link. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The Capsule implementation lives in Objects/capsule.c; there is no Objects/pycapsule.c (the header half of the sentence is correct). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
lnotab_notes.txt was removed in pythongh-134690 with the last co_lnotab support. The line-number/locations table is now documented in InternalDocs/code_objects.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
jit_stencils.h is a gitignored build artifact, so the relative link 404s on GitHub. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(text)[url] does not render as a link. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ZayanKhan-12
requested review from
AA-Turner,
brandtbucher,
corona10,
diegorusso,
emmatyping,
erlend-aasland,
freakboy3742,
itamaro,
mhsmith and
savannahostrowski
as code owners
July 26, 2026 22:31
|
The following commit authors need to sign the Contributor License Agreement: |
Documentation build overview
5 files changed ·
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes the stale file references collected in gh-154753, one commit per file:
Doc/using/android.rst— five:source:links updated toPlatforms/Android/...(moved in Move Android folder to Platforms #146445; the old links 404 on docs.python.org today)Doc/using/ios.rst—Platforms/Apple/iOS/README.md(×2), the testbed reference updated toPlatforms/Apple/testbed(the shared Apple testbed's actual location), theApplebuild-script mention, and thepython Apple/testbed clone ...shell example (matches the invocations inPlatforms/Apple/iOS/README.md)Doc/using/configure.rst—:source:`iOS/README.rst`→:source:`Platforms/Apple/iOS/README.md`(moved twice; the file is Markdown)Doc/extending/extending.rst—Objects/pycapsule.c→Objects/capsule.c(nopycapsule.cexists; theInclude/pycapsule.hhalf of the sentence is correct)Doc/library/sys.rst—Objects/lnotab_notes.txt(removed in Remove deprecatedco_lnotabfromCodeType#134690) →InternalDocs/code_objects.md, which documents the locations table that replaced lnotabInternalDocs/jit.md— drop the relative link tojit_stencils.h, a gitignored build artifact (404 on GitHub)InternalDocs/code_objects.md— fix inverted Markdown link syntax(text)[url]→[text](url)Every corrected target was verified to exist in the current tree, and each old target verified missing.
Backporting: the
Platforms/fixes (android.rst, ios.rst, configure.rst) must not be backported — 3.13/3.14 still have the pre-gh-146445 tree layout. The capsule.c and sys.rst fixes may be independently backport-eligible; happy to defer to the merger on labels.Verified locally on macOS:
make -C Doc checkandmake -C Doc html(which runs with--fail-on-warning) both pass; rendered HTML spot-checked for the new URLs.Prepared with AI assistance (Claude); every change was mechanically verified against the repository tree as described above.
📚 Documentation preview 📚: https://cpython-previews--154754.org.readthedocs.build/