sphinx-doc/sphinx

Consider adding add_object_type_to_domain() method

Open

#3.898 geöffnet am 29. Juni 2017

Auf GitHub ansehen
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (1.985 Forks)batch import
apidomainhelp wantedtype:proposal

Repository-Metriken

Stars
 (5.625 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 10T 11h) (11 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche die vorhandenen Implementierungen von add role to domain() und add directive to domain() im Sphinx Quellcode und füge dann eine neue Methode add object type to domain() nach dem gleichen Muster hinzu.
Tech Stack
python
Domain
documentationdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonSphinx development
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60