sphinx-doc/sphinx

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

Open

#6.689 geöffnet am 7. Sept. 2019

Auf GitHub ansehen
 (1 Kommentar) (3 Reaktionen) (0 zugewiesene Personen)Python (1.985 Forks)batch import
awaiting:responseextensions:todohelp wantedtype:enhancement

Repository-Metriken

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

Beschreibung

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

Contributor Guide

Research-Richtung
Diese Funktionsanfrage fordert eine `:todo:` Rolle, die wie die Todo Admonition inline funktioniert. Zur Implementierung untersuche `sphinx/ext/todo.py` (die vorhandene Erweiterung), um zu verstehen, wie die aktuelle Todo Direktive registriert wird. Füge dann eine neue Rollendefinition unter Verwendung von Sphinxs `roles.register generic role` oder einer benutzerdefinierten Rollenklasse hinzu. Verweise für Muster auf ähnliche Rollen im Sphinx Kern (z. B. `:ref:` oder `:doc:`). Die verlinkte Blender Entwicklerdiskussion (D5664) kann zusätzlichen Kontext liefern. Da das Issue offen ist und kein PR existiert, könnte der erste Schritt sein, zu kommentieren und zu bestätigen, ob diese Funktion noch gewünscht ist, und dann die Rolle zu implementieren.
Tech Stack
python
Domain
documentation
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.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75