Add the sphinx-codeautolink extension to the doc build process?
未關閉
還沒有人認領這個 Issue。
docs
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- PR 合併指標
- PR 指標待擷取
描述
I am proposing to include the https://github.com/felix-hilden/sphinx-codeautolink Sphinx extension into the documentation build process. This extension makes parseable Python code examples clickable so that it's easy to jump to the reference documentation of an object.
Related thread: https://discuss.python.org/t/add-the-sphinx-codeautolink-extension-to-doc-build-process/80814/11
A pull request to add the extension is upcoming.
Linked PRs
- gh-134896
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
研究方向
先檢視文件建置設定以及 issue 中連結的 sphinx-codeautolink 專案，然後閱讀相關的 discuss.python.org 討論串和 PR gh-134896。完成的標準是將此擴充功能納入文件建置，並讓可解析的 Python 範例成為指向參考文件的可點選連結。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 功能
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100