sphinx-doc/sphinx

Provide a better error message if the master document is not included in project documents

Open

#11.873 aberto em 12 de jan. de 2024

Ver no GitHub
 (3 comments) (4 reactions) (0 assignees)Python (1.985 forks)batch import
good first issuehelp wanted

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 13d 10h) (8 fundiu PRs em 30d)

Description

If index.rst does not appear in the pattern of a custom {include,exclude}_patterns, the error message is less than helpful. Instead, we should check that the master doc appears in the Project documents, and provide a better error if it doesn’t.

Inspiration from https://github.com/sphinx-doc/sphinx/issues/11722#issuecomment-1886157588

Guia do colaborador

Direção de pesquisa
A questão envolve verificar se o documento mestre (index.rst) aparece nos documentos do projeto após a aplicação do padrão. O código relevante provavelmente está em sphinx/project/ init .py, onde ocorre a descoberta de documentos. O objetivo é adicionar uma etapa de validação após a descoberta dos documentos e gerar um erro claro se o documento mestre estiver ausente. Revise o tratamento de erros existente e a issue de referência #11722 para contexto.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Basic PythonFamiliarity with Sphinx project structure
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65