falconry/falcon

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

Open

#1,888 opened on Mar 16, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (925 forks)batch import
documentationgood first issueneeds contributor

Repository metrics

Stars
 (9,293 stars)
PR merge metrics
 (Avg merge 2d 7h) (9 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Check Sphinx documentation for the 'nitpicky' option and how to enable warnings on broken links.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90