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