python / python/mypy

[docs feature] keep more readthedocs versions around

Aperta
#19,922 5 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation topic-developer
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Leggi la documentazione di Read the Docs sulle versioni collegata nell’issue, quindi esamina la configurazione Read the Docs esistente del repository. Abilita versioni precedenti selezionabili della documentazione e configúralе in modo che usino i tag anziché i branch; il lavoro è completato quando la documentazione precedente di mypy è disponibile su mypy.readthedocs.io senza dipendere da branch obsoleti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.