falconry/falcon

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

Open

#1.888 aberto em 16 de mar. de 2021

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

Métricas do repositório

Stars
 (9.293 stars)
Métricas de merge de PR
 (Mesclagem média 2d 7h) (9 fundiu PRs em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
Verifique a documentação do Sphinx para a opção 'nitpicky' e como habilitar avisos sobre links quebrados.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90