Repository navigation
Provide normalize_doctree_xml via sphinx_design.testing #260
Description
Activity
- changed the title
[-]Provide `normalize_doctree_xml` via `sphinx_design_elements.testing`[/-][+]Provide `normalize_doctree_xml` via `sphinx_design.testing`[/+]on Jul 12, 2026 This has landed in #277 and will be in the next release:
from sphinx_design.testing import normalize_doctree_xml(plus theSphinxBuilderwrapper), importable with onlysphinx_designinstalled — no test extras needed. There's a short "Testing utilities" docs page with the stability policy: helper signatures are covered by the deprecation policy, but the exact normalized output across docutils versions is not.This should let
sphinx-design-elementsdrop its own copy. One heads-up for the same migration: its test conftest currently imports the privatesphinx_design._compat.findall, which was removed in #276 — switching those call sites tonode.findall(...)(docutils ≥0.18 is guaranteed by the Sphinx floor) plus adopting the public helper should cover it.
Generated by Claude Code
Hi Chris,
thank you very much, I already created a note about it:
Thank you also for your other suggestions about a smooth migration path.
With kind regards,
Andreas.
Thank you for swiftly resolving compatibility with docutils 0.22 (GH-249, GH-255). We could also use the
normalize_doctree_xmlhelper function in downstream projects instead of using custom crafted workarounds. Maybe relocate it to thesphinx_design_elements.testingmodule, to ship it with the package, so package consumers can use it right away?