python / python/mypy

[docs feature] keep more readthedocs versions around

Abierto
#19,922 5 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

documentation topic-developer
Lenguaje dominante
Python
Estrellas
20.6k
Forks
3.3k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Lee la documentación de Read the Docs sobre versiones enlazada en la issue y, después, inspecciona la configuración existente de Read the Docs del repositorio. Habilita versiones antiguas seleccionables de la documentación y configúralas para que usen tags en lugar de branches; se considera terminado cuando la documentación antigua de mypy está disponible en mypy.readthedocs.io sin depender de branches obsoletos.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.