apache/dolphinscheduler

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

Open

#7,963 建立於 2022年1月12日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Java (4,324 fork)batch import
Pyschedulerdocumentfeaturehelp wanted

倉庫指標

Star
 (11,659 star)
PR 合併指標
 (平均合併 2天 21小時) (30 天內合併 22 個 PR)

描述

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
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
較久未更新
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonSphinx
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65