apache/dolphinscheduler

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

Ouverte

#7 963 ouverte le 12 janv. 2022

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Java (4 324 forks)batch import
Pyschedulerdocumentfeaturehelp wanted

Métriques du dépôt

Stars
 (11 659 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Créez une nouvelle extension Sphinx (par exemple, dolphin code include.py) dans le répertoire docs/source/ ext/. Implémentez une directive qui lit un fichier source et inclut un extrait entre des marqueurs. Mettez à jour docs/source/conf.py pour charger l'extension. Reportez vous au guide de développement d'extensions Sphinx à l'adresse https://www.sphinx doc.org/en/master/development/index.html. Testez avec la documentation existante pour garantir une citation correcte.
Stack technique
python
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65