python / python/docs-community

Host the Python docs on ReadTheDocs

Abierto
#5 40 comentarios 4 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

discussion
Lenguaje dominante
Makefile
Estrellas
55
Forks
26
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

From time to time the discussion arise about moving docs.python.org to readthedocs, there's even an experimental python.readthedocs.io.

I think there's many pros and cons of using readthedocs.

I'd personally be in favor of it if we (the PSF) support them (the cpython Doc is a big one with a lot of traffic, it take around 24h of CPU to build all versions × languages with all PDF A4, PDF letter, HTML, plaintext, epub).

In the other hand it's not an easy task, among other things docs.python.org is not only about generating the docs but also hosting history:

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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

Empieza revisando el alojamiento y el proceso de compilación actuales de docs.python.org y compáralos después con la configuración experimental de python.readthedocs.io. Presta especial atención al historial de versiones, Python 2.0 y otras versiones antiguas, así como a la carga de compilación indicada para múltiples versiones, idiomas y formatos. Se considerará terminado cuando exista un plan de migración concreto que preserve esos requisitos y resuelva las disyuntivas entre la PSF y el alojamiento.

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

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.