sphinx-doc/sphinx

Support todo roles in the `sphinx.ext.todo` extension

Open

#6.689 aberto em 7 de set. de 2019

Ver no GitHub
 (1 comment) (3 reactions) (0 assignees)Python (1.985 forks)batch import
awaiting:responseextensions:todohelp wantedtype:enhancement

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

Is your feature request related to a problem? Please describe. Sometimes it is convenient to note a todo inline which is not possible using the todo admonition. However there seems to be the todo role. This would require also creating a custom role.

Describe the solution you'd like Using :todo:`todo message` should work the same as using the todo admonition.

Context

https://developer.blender.org/D5664

Guia do colaborador

Direção de pesquisa
Esta solicitação de recurso pede por um papel `:todo:` que funcione como a advertência de tarefa (todo) inline. Para implementar, examine `sphinx/ext/todo.py` (a extensão existente) para entender como a diretiva atual de tarefa é registrada. Em seguida, adicione uma nova definição de papel usando `roles.register generic role` do Sphinx ou uma classe de papel personalizada. Consulte papéis semelhantes no núcleo do Sphinx (por exemplo, `:ref:` ou `:doc:`) para padrões. A discussão vinculada de desenvolvedores do Blender (D5664) pode fornecer contexto adicional. Como a issue está aberta e não há PR, o primeiro passo pode ser comentar para confirmar se esse recurso ainda é desejado e, em seguida, implementar o papel.
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.
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75