sphinx-doc/sphinx

Consider adding add_object_type_to_domain() method

Open

#3.898 aberto em 29 de jun. de 2017

Ver no GitHub
 (2 comments) (1 reaction) (0 assignees)Python (1.985 forks)batch import
apidomainhelp wantedtype:proposal

Métricas do repositório

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

Description

The current Sphinx api regarding extending domains is very confusing: why is there add_role_to_domain(), and add_directive_to_domain() but no add_object_type_to_domain() ? So if someone wants to add new object types to existing domain, the proper way now is to override the whole domain and add new types in the new class. It's also confusing because developer may mix inheritance-based customization and app-method-based customization. Having to use one, or another, but not both could improve the clarity.

Guia do colaborador

Direção de pesquisa
Estude as implementações existentes de add role to domain() e add directive to domain() no código fonte do Sphinx e adicione um novo método add object type to domain() seguindo o mesmo padrão.
Pilha de tecnologia
python
Domain
documentationdeveloper experience
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.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx development
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60