sphinx-doc/sphinx

Consider adding add_object_type_to_domain() method

Open

#3898 aperta il 29 giu 2017

Vedi su GitHub
 (2 commenti) (1 reazione) (0 assegnatari)Python (1985 fork)batch import
apidomainhelp wantedtype:proposal

Metriche repository

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

Descrizione

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.

Guida contributor

Direzione di ricerca
Studia le implementazioni esistenti di add role to domain() e add directive to domain() nel codice sorgente di Sphinx, quindi aggiungi un nuovo metodo add object type to domain() seguendo lo stesso schema.
Tech stack
python
Dominio
documentationdeveloper experience
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.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx development
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60