apache/dolphinscheduler

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

Open

#7,963 opened on 2022年1月12日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Java (4,324 forks)batch import
Pyschedulerdocumentfeaturehelp wanted

Repository metrics

Stars
 (11,659 stars)
PR merge metrics
 (平均マージ 2d 21h) (30d で 22 merged PRs)

説明

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

コントリビューターガイド

調査方針
docs/source/ ext/ ディレクトリに新しい Sphinx 拡張機能（例：dolphin code include.py）を作成します。ソースファイルを読み取り、マーカー間のスニペットを含めるディレクティブを実装します。docs/source/conf.py を更新して拡張機能を読み込みます。Sphinx 拡張機能開発ガイド（https://www.sphinx doc.org/en/master/development/index.html）を参照してください。既存のドキュメントでテストし、引用が正しいことを確認します。
技術スタック
python
領域
documentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonSphinx
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65