Docs: use linkcheck build to verify external links
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 150
- Forks
- 23
- Merge moyen
- 1 j 11 h
- PR mergées (30 j)
- 2
Description
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).
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Aucun fichier ni test n’est indiqué. Commencez par localiser la configuration de build de la documentation Sphinx et les références au processus de release, puis consultez la documentation du builder linkcheck. Le travail est terminé lorsque le build de la documentation de release vérifie les liens externes et signale les liens brisés comme des avertissements, sans nécessiter de test manuel des liens.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation, release
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100