Add content_offset parameter to nested_parse_with_titles
#11147
Conversation
jbms
force-pushed
the
fix-nested-parse-with-titles-source-info
branch
from
f69851a
to
3b30989
Compare
Previously, `nested_parse_with_titles` always passed `0` as the input offset when invoking `nested_parse`. When parsing the content of a directive, as is a common use case for `nested_parse_with_titles`, this leads to incorrect source file/line number information, as it does not take into account the directive's `content_offset`, which is always non-zero. This issue affects *all* object descriptions due to sphinx-doc#10887. It also affects the `ifconfig` extension. The `py:module` and `js:module` directives employed a workaround for this issue, by wrapping the calls to `nested_parse_with_title` with `switch_source_input`. That worked, but was more complicated (and likely less efficient) than necessary. This commit adds an optional `content_offset` parameter to `nested_parse_with_titles`, and fixes callers to pass the appropriate content offset when needed. This commit eliminates the now-unnecessary calls to `switch_source_input` and instead specifies the correct `content_offset`.
jbms
force-pushed
the
fix-nested-parse-with-titles-source-info
branch
from
3b30989
to
7879ab1
Compare
|
Note: An alternative fix would be to modify |
…iptions This addresses the issue described at sphinx-doc/sphinx#11147.
…iptions This addresses the issue described at sphinx-doc/sphinx#11147.
|
merging latest master update into this, for CI checks |
|
After the merge, CI seems to pass. |
|
@jfbu It would be great if this fix can be merged soon. What do you think? |
@jbms it looks good to me but I am the LaTeX contractor here so pinging @AA-Turner |
Oh, I see. Unfortunately he said he was out until Easter: #11116 (comment) |
AA-Turner
changed the title
content_offset parameter to nested_parse_with_titles
Feature or Bugfix
Purpose
Previously,
nested_parse_with_titlesalways passed0as the input offset when invokingnested_parse. When parsing the content of a directive, as is a common use case fornested_parse_with_titles, this leads to incorrect source file/line number information, as it does not take into account the directive'scontent_offset, which is always non-zero.This issue affects all object descriptions due to #10887. It also affects the
ifconfigextension.The
py:moduleandjs:moduledirectives employed a workaround for this issue, by wrapping the calls tonested_parse_with_titlewithswitch_source_input. That worked, but was more complicated (and likely less efficient) than necessary.This commit adds an optional
content_offsetparameter tonested_parse_with_titles, and fixes callers to pass the appropriate content offset when needed.This commit eliminates the now-unnecessary calls to
switch_source_inputand instead specifies the correctcontent_offset.