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
8de6638697
sphinx/tests
History
Jeremy Maitin-Shepard 8de6638697
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``.
2023-02-15 05:45:28 +00:00
..
certs linkcheck: Specify subjectAltName in test self-signed certificate 2020-11-15 18:25:39 +01:00
js Split out sphinx_highlight.js 2022-09-24 15:10:57 +01:00
roots LaTeX: fix 5.1.0 bugs related to topic and contents boxes (#11102) 2023-01-06 23:52:19 +01:00
__init__.py Make tests/ a Python package 2020-11-20 19:43:02 +01:00
conftest.py Skip sphinx.locale.init_console when running tests (#11159) 2023-01-31 22:10:48 +00:00
ext_napoleon_pep526_data_google.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
ext_napoleon_pep526_data_numpy.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_api_translator.py Increase minimum Docutils to 0.17 2022-09-27 18:31:47 +01:00
test_application.py Use path2doc rather than reinventing the wheel 2022-09-26 17:50:57 +01:00
test_build_changes.py .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
test_build_dirhtml.py Fix various Ruff errors 2023-01-31 18:30:43 +00:00
test_build_epub.py Undo parallel image changes 2023-01-10 14:53:17 +00:00
test_build_gettext.py Cache doctrees more efficiently 2023-01-04 05:46:23 +00:00
test_build_html.py Undo parallel image changes 2023-01-10 14:53:17 +00:00
test_build_latex.py Merge branch '6.1.x' 2023-01-10 16:00:59 +00:00
test_build_linkcheck.py Insert `from __future__ import annotations` 2023-01-01 20:48:37 +00:00
test_build_manpage.py Revert "Fix detection for out of date files (#9360)" (#10908) 2022-10-13 13:16:17 +01:00
test_build_texinfo.py Undo parallel image changes 2023-01-10 14:53:17 +00:00
test_build_text.py .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
test_build.py Clean up after dropping Python 3.6 2022-09-27 18:31:47 +01:00
test_builder.py .write_text(...) -> .write_text(..., encoding='utf8') 2022-04-27 03:11:08 +01:00
test_catalogs.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_config.py Update test_config.py::test_needs_sphinx for Alabaster 0.7.13 compat 2023-01-21 11:11:03 +01:00
test_correct_year.py .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
test_directive_code.py Enable Ruff's pylint 'PLC2201' check 2022-12-30 00:06:11 +00:00
test_directive_object_description.py Add `content_offset parameter to nested_parse_with_titles` (#11147) 2023-02-15 05:45:28 +00:00
test_directive_only.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_directive_other.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_directive_patch.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_docutilsconf.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_domain_c.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_domain_cpp.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_domain_js.py Add `content_offset parameter to nested_parse_with_titles` (#11147) 2023-02-15 05:45:28 +00:00
test_domain_py.py Add `content_offset parameter to nested_parse_with_titles` (#11147) 2023-02-15 05:45:28 +00:00
test_domain_rst.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_domain_std.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_environment_indexentries.py Fix Ruff bidirectional text errors 2023-02-11 13:17:18 +00:00
test_environment_record_dependencies.py Clear record_dependencies for each document (#10855) 2022-09-24 00:31:26 +01:00
test_environment_toctree.py Add contents entries for domain objects (#10807) 2022-09-13 20:20:02 +01:00
test_environment.py Increase static typing strictness (#10530) 2022-06-16 19:50:01 +01:00
test_errors.py Drop python 3.6 support (#10468) 2022-06-16 19:33:55 +01:00
test_events.py Make -P (pdb) work better with exceptions triggered from events 2022-07-04 18:48:44 -07:00
test_ext_apidoc.py Run the `pyupgrade` tool 2022-10-17 22:39:09 +01:00
test_ext_autodoc_autoattribute.py Document `typing.NewType` as a class (#10700) 2023-01-02 18:57:04 +00:00
test_ext_autodoc_autoclass.py Document `typing.NewType` as a class (#10700) 2023-01-02 18:57:04 +00:00
test_ext_autodoc_autodata.py Document `typing.NewType` as a class (#10700) 2023-01-02 18:57:04 +00:00
test_ext_autodoc_autofunction.py Drop python 3.6 support (#10468) 2022-06-16 19:33:55 +01:00
test_ext_autodoc_automodule.py Merge branch '5.x' 2022-09-23 17:27:00 +01:00
test_ext_autodoc_autoproperty.py Drop Python 3.7 2022-09-27 18:31:47 +01:00
test_ext_autodoc_configs.py Document `typing.NewType` as a class (#10700) 2023-01-02 18:57:04 +00:00
test_ext_autodoc_events.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_ext_autodoc_mock.py Insert `from __future__ import annotations` 2023-01-01 20:48:37 +00:00
test_ext_autodoc_preserve_defaults.py Drop Python 3.7 2022-09-27 18:31:47 +01:00
test_ext_autodoc_private_members.py Add test cases for #8180 2022-05-23 02:04:03 +09:00
test_ext_autodoc.py Document `typing.NewType` as a class (#10700) 2023-01-02 18:57:04 +00:00
test_ext_autosectionlabel.py Show the repr of the value in some warnings (#10439) 2022-06-16 21:07:25 +01:00
test_ext_autosummary.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_ext_coverage.py .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
test_ext_doctest.py Enable Ruff's pylint checks 2022-12-29 23:53:48 +00:00
test_ext_duration.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_ext_extlinks.py Don't display 'replaceable hardcoded link' when link has a slash (#10137) 2022-10-05 14:47:16 +01:00
test_ext_githubpages.py .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
test_ext_graphviz.py Increase minimum Docutils to 0.17 2022-09-27 18:31:47 +01:00
test_ext_ifconfig.py Add `content_offset parameter to nested_parse_with_titles` (#11147) 2023-02-15 05:45:28 +00:00
test_ext_imgconverter.py Run the `pyupgrade` tool 2022-10-17 22:39:09 +01:00
test_ext_inheritance_diagram.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_ext_intersphinx.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_ext_math.py Cache doctrees more efficiently 2023-01-04 05:46:23 +00:00
test_ext_napoleon_docstring.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_ext_napoleon_iterators.py Treat Python warnings as errors during testing 2023-02-15 04:34:10 +00:00
test_ext_napoleon.py Merge branch '5.x' 2022-08-06 18:31:14 +02:00
test_ext_todo.py .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
test_ext_viewcode.py Run pyupgrade (#11070) 2023-01-02 00:01:14 +00:00
test_extension.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_highlighting.py Fix highlighting lexers 2022-09-25 00:10:59 +01:00
test_intl.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_locale.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_markup.py Add test for multi-word key names (`kbd` role) (#10765) 2022-12-30 00:57:51 +00:00
test_metadata.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_parser.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_project.py .write_text(...) -> .write_text(..., encoding='utf8') 2022-04-27 03:11:08 +01:00
test_pycode_ast.py Drop Python 3.7 2022-09-27 18:31:47 +01:00
test_pycode_parser.py Remove traces of Python 2 and 3.5 (#10560) 2022-06-16 21:37:46 +01:00
test_pycode.py Drop Python 3.7 2022-09-27 18:31:47 +01:00
test_quickstart.py Enable Ruff's flake8-bandit checks 2022-12-29 23:53:48 +00:00
test_roles.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_search.py Restore correct parallel search index building (#11192) 2023-02-15 05:26:10 +00:00
test_setup_command.py Treat Python warnings as errors during testing 2023-02-15 04:34:10 +00:00
test_smartquotes.py Increase minimum Docutils to 0.18 2022-09-27 18:31:47 +01:00
test_templating.py .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
test_theming.py Remove deprecated items for Sphinx 6.0 (#10471) 2022-06-16 21:05:37 +01:00
test_toctree.py .write_text(...) -> .write_text(..., encoding='utf8') 2022-04-27 03:11:08 +01:00
test_transforms_post_transforms_code.py .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
test_transforms_post_transforms.py Review comments 2022-06-01 18:10:55 +01:00
test_util_display.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_util_docstrings.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_util_docutils.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_util_fileutil.py Use the flake8-comprehensions lint plugin (#10601) 2022-06-26 14:43:05 +01:00
test_util_i18n.py .write_text(...) -> .write_text(..., encoding='utf8') 2022-04-27 03:11:08 +01:00
test_util_images.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_util_inspect.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_util_inventory.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_util_logging.py logging: always show source locations as absolute paths (#10460) 2022-06-16 19:51:49 +01:00
test_util_matching.py Update include_patterns implementation (#10680) 2022-07-23 21:19:35 +01:00
test_util_nodes.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_util_rst.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_util_template.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
test_util_typing.py Adopt `profile = "black" for isort` 2023-01-07 18:31:15 +00:00
test_util.py Move XML Name pattern to `epub3` 2023-01-03 22:36:54 +00:00
test_versioning.py Increase minimum Docutils to 0.18 2022-09-27 18:31:47 +01:00
test_writer_latex.py Collapse single line docstrings 2022-02-20 03:13:45 +00:00
typing_test_data.py Fix various Ruff errors 2023-01-31 18:30:43 +00:00
utils.py refactor: ssl.wrap_context() has been deprecated now 2021-12-11 11:38:24 +09:00