apache/dolphinscheduler

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

Closed

#8,233 opened on Jan 28, 2022

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Java (4,324 forks)batch import
Pyschedulercommunitydocumentfeaturehelp wanted

Repository metrics

Stars
 (11,659 stars)
PR merge metrics
 (Avg merge 2d 21h) (22 merged PRs in 30d)

Description

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

Contributor guide

Research direction
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
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinxDocumentation generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60