falconry/falcon

Doc: Explore Sphinx options if there is a flag to emit a warning on broken links

Offen

#1.888 geöffnet am 16.03.2021

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (925 Forks)batch import
documentationgood first issueneeds contributor

Repository-Metriken

Stars
 (9.293 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 7h) (9 gemergte PRs in 30 T)

Beschreibung

Setting nitpicky = True in conf.py or passing the -n command line argument will warn on broken links.

Contributor Guide

Research-Richtung
Überprüfen Sie die Sphinx Dokumentation zur 'nitpicky' Option und wie Sie Warnungen zu defekten Links aktivieren.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90