sphinx-doc/sphinx

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

Open

#6,689 opened on Sep 7, 2019

View on 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
 (Avg merge 10d 11h) (11 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Study the implementation of the 'todo' directive in sphinx/ext/todo.py and create a similar role 'todo' using the role() or register custom role() function. Then add it to the extension's setup function.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75