NCAS-CMS / NCAS-CMS/cf-python

Docs: use linkcheck build to verify external links

Abierto
#175 0 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

documentation
Lenguaje dominante
Python
Estrellas
150
Forks
23
Merge medio
1 d 11 h
PR fusionados (30 d)
2

Descripción

As part of our release process we manually test links e.g. to the relevant sections in the CF conventions. This check can be largely automated (all but fixing incorrect links) by running the sphinx.builders.linkcheck builder which detects broken links and raises warnings if they are found.

Addressing this will help towards automation of the release process (see #134).

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

No se ha indicado ningún archivo ni prueba. Empieza localizando la configuración de compilación de la documentación de Sphinx y las referencias al proceso de release; después, revisa la documentación del builder linkcheck. La tarea estará terminada cuando la compilación de la documentación de release compruebe los enlaces externos y notifique los enlaces rotos como advertencias, sin requerir pruebas manuales de enlaces.

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

Evaluación

Stack tecnológico
python
Área
documentation, release
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.