python / python/cpython

Fix all Sphinx reference warnings in the documentation (meta issue)

Offen
#151,940 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs type-bug
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

This supersedes the previous closed issue for this: https://github.com/python/cpython/issues/101100

I have created several sub-issues (see table below) to split the work up and avoid what happened the last time. This is the meta issue for this task, any general discussion on this topic should go here, not on the sub-issues, and vice-versa.

In each of the issues, I've added the current list of warnings. Note that the warnings themselves, and their line numbers may change.


There are some warnings that come up with no file:

TODO: Figure these out.
<unknown>:922: c:type reference target not found: PyWeakReference [ref.type]
<unknown>:956: c:data reference target not found: Py_FileSystemDefaultEncodeErrors [ref.data]
<unknown>:957: c:data reference target not found: Py_FileSystemDefaultEncoding [ref.data]
<unknown>:970: c:data reference target not found: Py_HasFileSystemDefaultEncoding [ref.data]
<unknown>:1026: c:data reference target not found: Py_UTF8Mode [ref.data]
<unknown>:1037: c:type reference target not found: Py_intptr_t [ref.type]
<unknown>:1141: c:type reference target not found: Py_uintptr_t [ref.type]
<unknown>:1168: c:type reference target not found: ssizessizeargfunc [ref.type]
<unknown>:1169: c:type reference target not found: ssizessizeobjargproc [ref.type]
<unknown>:1170: c:type reference target not found: symtable [ref.type]
Linked PRs
  • gh-153086

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Öffne zunächst die in der Meta-Issue referenzierten Unter-Issues und überprüfe deren aktuelle Warnungslisten; die Warnungen und Zeilennummern können sich ändern. Arbeite die aufgeführten Referenzwarnungen einschließlich der Ziele ohne Datei durch, und betrachte die Arbeit als abgeschlossen, wenn der Sphinx-Dokumentations-Build keine verbleibenden Referenzwarnungen meldet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.