python / python/peps

PEP 12: Add list of intersphinx mappings

Ouverte
#4,610 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
reStructuredText
Étoiles
5k
Forks
1.8k
Merge moyen
2 j 4 h
PR mergées (30 j)
25

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser PEP 12 et la configuration Sphinx référencée dans l’issue. Confirmez où sont maintenus les mappages intersphinx, puis mettez à jour PEP 12 avec la liste ou expliquez où les lecteurs peuvent la trouver ; le travail est considéré comme terminé lorsque les mappages disponibles peuvent être trouvés sans connaissance préalable de la configuration.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.