diff options
author | Jeremy Maitin-Shepard <jbms@google.com> | 2023-02-14 21:45:28 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-02-15 05:45:28 +0000 |
commit | 8de6638697b8c785f8022e1f526b549e74d033d1 (patch) | |
tree | e258ab7ff1b435ed4ec4c45a9c566205aee25b0f /doc/development/tutorials/examples/autodoc_intenum.py | |
parent | 44684e165426470e8e8befa45e32d1b0b2f6302e (diff) | |
download | sphinx-git-8de6638697b8c785f8022e1f526b549e74d033d1.tar.gz |
Add ``content_offset`` parameter to ``nested_parse_with_titles`` (#11147)
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 GH-10887. It also
affects the ``sphinx.ext.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``.
Diffstat (limited to 'doc/development/tutorials/examples/autodoc_intenum.py')
0 files changed, 0 insertions, 0 deletions