apache/dolphinscheduler

[Feature][python] Add sphinx ext to get part of code from example

Offen

#7.963 geöffnet am 12.01.2022

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Java (4.324 Forks)batch import
Pyschedulerdocumentfeaturehelp wanted

Repository-Metriken

Stars
 (11.659 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

To avoid duplicate code of the document, we should create a sphinx extension and quote code from the document. About extension for sphinx you could find in https://www.sphinx-doc.org/en/master/development/index.html.

Use case

No response

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Contributor Guide

Research-Richtung
Erstellen Sie eine neue Sphinx Erweiterung (z. B. dolphin code include.py) im Verzeichnis docs/source/ ext/. Implementieren Sie eine Direktive, die eine Quelldatei liest und einen Ausschnitt zwischen Markierungen einfügt. Aktualisieren Sie docs/source/conf.py, um die Erweiterung zu laden. Weitere Informationen finden Sie im Sphinx Erweiterungsentwicklungsleitfaden unter https://www.sphinx doc.org/en/master/development/index.html. Testen Sie mit der vorhandenen Dokumentation, um eine korrekte Zitierung sicherzustellen.
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.
1-2 Tage
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
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65