apache/dolphinscheduler

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

Open

#7,963 opened on Jan 12, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (4,324 forks)batch import
Pyschedulerdocumentfeaturehelp 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

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 direction
Study Sphinx extension development and implement an extension to include code snippets from example files.
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-2 days
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
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65