Skip to content

Test suite compatibility with docutils 0.22 #249

Closed

Description

@amotl

Describe the bug

context
When I run the test suite with docutils 0.22.

expectation
I expected it to succeed.

bug
But instead it failed, until all the snippets will be adjusted for boolean value renderings like @LocutusOfBorg is exercising.

problem
This is a problem for people aiming to support multiple versions of docutils because you can't predict which library version is accompanied by Sphinx.

references

Reproduce the bug

We've only reproduced it on the downstream sphinx-design-elements project, but @LocutusOfBorg also reproduced it on sphinx-design.

List your environment

Plain Sphinx, any version, but docutils (0.19, 0.20, 0.21) vs. 0.22. 💥

Workaround

We added a workaround (see below) to the test suite of sphinx-design-elements per patch_snippet_docutils_{forward,reverse} to accompany the test suite without needing to change the snippets themselves, in order to be able to support multiple versions of docutils. However, the workaround feels dirty. Maybe you can come up with a better solution?

Activity

  1. chrisjsewell commented on Dec 23, 2025

    @chrisjsewell
    Member

    Currently blocked on Currently blocked on #248

  2. linked a pull request that will close this issue⬆️ Add Sphinx 9 support #255on Jan 19, 2026
  3. amotl commented on Jan 19, 2026

    @amotl
    Author

    Thank you so much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions