sphinx-doc/sphinx

Support todo roles in the `sphinx.ext.todo` extension

Open

#6,689 建立於 2019年9月7日

在 GitHub 查看
 (1 留言) (3 反應) (0 負責人)Python (1,985 fork)batch import
awaiting:responseextensions:todohelp wantedtype:enhancement

倉庫指標

Star
 (5,625 star)
PR 合併指標
 (平均合併 10天 11小時) (30 天內合併 11 個 PR)

描述

Is your feature request related to a problem? Please describe. Sometimes it is convenient to note a todo inline which is not possible using the todo admonition. However there seems to be the todo role. This would require also creating a custom role.

Describe the solution you'd like Using :todo:`todo message` should work the same as using the todo admonition.

Context

https://developer.blender.org/D5664

貢獻者指南

研究方向
此功能請求要求一個類似待辦事項提示框內聯的 `:todo:` 角色。為實現此功能，請檢查 `sphinx/ext/todo.py`（現有擴充功能）以了解當前待辦事項指令的註冊方式。然後，使用 Sphinx 的 `roles.register generic role` 或自訂角色類別新增角色定義。可參考 Sphinx 核心中的類似角色（例如 `:ref:` 或 `:doc:`）以獲取模式參考。連結的 Blender 開發者討論（D5664）可能提供額外背景資訊。由於該議題仍處於開放狀態且無 PR，第一步可以是在議題下留言以確認此功能是否仍有需求，然後實作該角色。
技術棧
python
領域
documentation
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonSphinx
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75