PEP 12: Add list of intersphinx mappings

Offen
#4,610 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
48/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Beginne damit, PEP 12 und die im Issue referenzierte Sphinx-Konfiguration zu finden. Bestätige, wo die intersphinx-Zuordnungen gepflegt werden, und aktualisiere dann PEP 12 mit der Liste oder erkläre, wo Leser sie finden können; abgeschlossen bedeutet, dass die verfügbaren Zuordnungen ohne vorherige Kenntnis der Konfiguration auffindbar sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

PEP 12 is very helpful in writing PEPs and has a section on intersphinx. However, to know the available intersphinx mappings, one has to know where to look in the sphinx configuration.

I think it would be useful to include the list directly in PEP 12.

Alternatively, if that is considered to be at too high a risk for getting outdated, one could add an explanation on where to find it.

Vorherrschende Sprache
reStructuredText
Sterne
5k
Forks
1.8k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
25

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python/peps

Alle Issues in python/peps

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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