apache/dolphinscheduler

[Feature][python] Add google translate buttom to python doc

Chiusa

#8233 aperta il 28 gen 2022

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (0 assegnatari)Java (4324 fork)batch import
Pyschedulercommunitydocumentfeaturehelp wanted

Metriche repository

Star
 (11.659 stelle)
Metriche merge PR
 (Merge medio 2g 21h) (22 PR mergiate in 30 g)

Descrizione

Search before asking

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

Description

For now we only have Egnlish version in python api doc, https://dolphinscheduler.apache.org/python/index.html. I think it better to support multiple languages with some tricks instead of translate it by hand. see https://www.commonwl.org/user_guide/ have google translate . maybe we should add a sphinx ext to do it

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
Investigate the Sphinx configuration file (likely /docs/conf.py or similar) to understand current setup. Look into existing Sphinx extensions for Google Translate (e.g., sphinx intl or custom). Check the example at https://www.commonwl.org/user guide/ for inspiration. Implement a Sphinx extension that adds a Google Translate button to the documentation pages. Ensure it works with the existing theme and does not break other functionality.
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-3 ore
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
PythonSphinxDocumentation generation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60