IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Enable automatic formatting for `sphinx/ext/todo.py`

Browse Source
This commit is contained in:
Adam Turner 2024-12-27 19:18:46 +00:00
parent e6ede7250d
commit e66c81b01d
2 changed files with 25 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.ruff.toml
View File

@ -415,6 +415,5 @@ exclude = [
"sphinx/domains/python/_object.py", "sphinx/domains/python/_object.py",
"sphinx/domains/rst.py", "sphinx/domains/rst.py",
"sphinx/domains/std/__init__.py", "sphinx/domains/std/__init__.py",
"sphinx/ext/todo.py",
"sphinx/ext/viewcode.py", "sphinx/ext/viewcode.py",
] ]

41
sphinx/ext/todo.py
View File

@ -93,16 +93,18 @@ class TodoDomain(Domain):
for docname in docnames: for docname in docnames:
self.todos[docname] = otherdata['todos'][docname] self.todos[docname] = otherdata['todos'][docname]
def process_doc(self, env: BuildEnvironment, docname: str, def process_doc(
document: nodes.document) -> None: self, env: BuildEnvironment, docname: str, document: nodes.document
) -> None:
todos = self.todos.setdefault(docname, []) todos = self.todos.setdefault(docname, [])
for todo in document.findall(todo_node): for todo in document.findall(todo_node):
env.events.emit('todo-defined', todo) env.events.emit('todo-defined', todo)
todos.append(todo) todos.append(todo)
if env.config.todo_emit_warnings: if env.config.todo_emit_warnings:
logger.warning(__("TODO entry found: %s"), todo[1].astext(), logger.warning(
location=todo) __('TODO entry found: %s'), todo[1].astext(), location=todo
)
class TodoList(SphinxDirective): class TodoList(SphinxDirective):
@ -134,7 +136,8 @@ class TodoListProcessor:
def process(self, doctree: nodes.document, docname: str) -> None: def process(self, doctree: nodes.document, docname: str) -> None:
todos: list[todo_node] = functools.reduce( todos: list[todo_node] = functools.reduce(
operator.iadd, self.domain.todos.values(), []) operator.iadd, self.domain.todos.values(), []
)
for node in list(doctree.findall(todolist)): for node in list(doctree.findall(todolist)):
if not self.config.todo_include_todos: if not self.config.todo_include_todos:
node.parent.remove(node) node.parent.remove(node)
@ -162,11 +165,13 @@ class TodoListProcessor:
if self.config.todo_link_only: if self.config.todo_link_only:
description = _('<<original entry>>') description = _('<<original entry>>')
else: else:
description = (_('(The <<original entry>> is located in %s, line %d.)') % description = _('(The <<original entry>> is located in %s, line %d.)') % (
(todo.source, todo.line)) todo.source,
todo.line,
)
prefix = description[:description.find('<<')] prefix = description[: description.find('<<')]
suffix = description[description.find('>>') + 2:] suffix = description[description.find('>>') + 2 :]
para = nodes.paragraph(classes=['todo-source']) para = nodes.paragraph(classes=['todo-source'])
para += nodes.Text(prefix) para += nodes.Text(prefix)
@ -175,7 +180,9 @@ class TodoListProcessor:
linktext = nodes.emphasis(_('original entry'), _('original entry')) linktext = nodes.emphasis(_('original entry'), _('original entry'))
reference = nodes.reference('', '', linktext, internal=True) reference = nodes.reference('', '', linktext, internal=True)
try: try:
reference['refuri'] = self.builder.get_relative_uri(docname, todo['docname']) reference['refuri'] = self.builder.get_relative_uri(
docname, todo['docname']
)
reference['refuri'] += '#' + todo['ids'][0] reference['refuri'] += '#' + todo['ids'][0]
except NoUri: except NoUri:
# ignore if no URI can be determined, e.g. for LaTeX output # ignore if no URI can be determined, e.g. for LaTeX output
@ -237,12 +244,14 @@ def setup(app: Sphinx) -> ExtensionMetadata:
app.add_config_value('todo_emit_warnings', False, 'html') app.add_config_value('todo_emit_warnings', False, 'html')
app.add_node(todolist) app.add_node(todolist)
app.add_node(todo_node, app.add_node(
html=(visit_todo_node, depart_todo_node), todo_node,
latex=(latex_visit_todo_node, latex_depart_todo_node), html=(visit_todo_node, depart_todo_node),
text=(visit_todo_node, depart_todo_node), latex=(latex_visit_todo_node, latex_depart_todo_node),
man=(visit_todo_node, depart_todo_node), text=(visit_todo_node, depart_todo_node),
texinfo=(visit_todo_node, depart_todo_node)) man=(visit_todo_node, depart_todo_node),
texinfo=(visit_todo_node, depart_todo_node),
)
app.add_directive('todo', Todo) app.add_directive('todo', Todo)
app.add_directive('todolist', TodoList) app.add_directive('todolist', TodoList)