sphinx-doc/sphinx

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

Open

#6689 aperta il 7 set 2019

Vedi su GitHub
 (1 commento) (3 reazioni) (0 assegnatari)Python (1985 fork)batch import
awaiting:responseextensions:todohelp wantedtype:enhancement

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Questa richiesta di funzionalità chiede un ruolo `:todo:` che funzioni come l'avvertenza todo inline. Per implementarlo, esamina `sphinx/ext/todo.py` (l'estensione esistente) per capire come viene registrata l'attuale direttiva todo. Quindi, aggiungi una nuova definizione di ruolo utilizzando `roles.register generic role` di Sphinx o una classe di ruolo personalizzata. Fai riferimento a ruoli simili nel core di Sphinx (ad es. `:ref:` o `:doc:`) per i pattern. La discussione collegata degli sviluppatori di Blender (D5664) potrebbe fornire ulteriore contesto. Poiché l'issue è aperta e non esiste una PR, il primo passo potrebbe essere commentare per confermare se questa funzionalità è ancora desiderata e quindi implementare il ruolo.
Tech stack
python
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75