sphinx-doc/sphinx

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

Open

#6,689 opened on 2019年9月7日

GitHub で見る
 (1 comment) (3 reactions) (0 assignees)Python (1,985 forks)batch import
awaiting:responseextensions:todohelp wantedtype:enhancement

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (平均マージ 10d 11h) (30d で 11 merged PRs)

説明

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 アドモニション（警告）をインラインで動作させる `:todo:` ロールを求めています。実装するには、既存の拡張機能である `sphinx/ext/todo.py` を調べて、現在の todo ディレクティブがどのように登録されているかを理解します。次に、Sphinx の `roles.register generic role` またはカスタムロールクラスを使用して新しいロール定義を追加します。パターンの参考として、Sphinx コア内の類似ロール（例：`:ref:` や `:doc:`）を参照してください。リンクされている Blender 開発者ディスカッション（D5664）は追加の文脈を提供する可能性があります。この issue はオープンで PR が存在しないため、最初のステップとして、この機能がまだ必要かどうかをコメントで確認し、その後ロールを実装することが考えられます。
技術スタック
python
領域
documentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonSphinx
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75