python / python/mypy

[docs feature] keep more readthedocs versions around

Ouverte
#19,922 5 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

documentation topic-developer
Langage dominant
Python
Étoiles
20.6k
Forks
3.3k
Métriques de merge des PR
Métriques de PR en attente

Description

Currently on https://mypy.readthedocs.io/ you can switch between stable and latest versions of the documentation, which is very convenient. However, what if you want to look at an older version of the documentation, such as if your installed mypy version is older or perhaps you want to track down when something changed in mypy history? Not so convenient now, because you can't go look at old versions of the documentation. However, this seems to be a feature that one can enable in readthedocs, called (in general) "versions" https://docs.readthedocs.com/platform/latest/versions.html and it seems to be free for community users as well https://about.readthedocs.com/pricing/#/community ("Documentation versioning", here, not to be confused with "build concurrency"), so, that seems like a useful thing to do.

On another note, the old versions should be configured to use tags not branches, so that we can get rid of stale branches à la https://github.com/python/mypy/issues/19795

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

Lisez la documentation de Read the Docs sur les versions liée dans l’issue, puis examinez la configuration Read the Docs existante du dépôt. Activez la sélection d’anciennes versions de la documentation et configurez-les pour utiliser des tags plutôt que des branches ; le travail est terminé lorsque l’ancienne documentation de mypy est disponible sur mypy.readthedocs.io sans dépendre de branches obsolètes.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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