apache/dolphinscheduler

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

Aperta

#7963 aperta il 12 gen 2022

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Java (4324 fork)batch import
Pyschedulerdocumentfeaturehelp wanted

Metriche repository

Star
 (11.659 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Crea una nuova estensione Sphinx (ad esempio, dolphin code include.py) nella directory docs/source/ ext/. Implementa una direttiva che legge un file sorgente e include uno snippet tra i marcatori. Aggiorna docs/source/conf.py per caricare l'estensione. Fai riferimento alla guida per lo sviluppo delle estensioni Sphinx all'indirizzo https://www.sphinx doc.org/en/master/development/index.html. Testa con la documentazione esistente per garantire una citazione corretta.
Tech stack
python
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
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
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65