Skip to content

Tests: add reference URI test coverage for 'singlehtml' builder - #14240

Closed
jayaddison wants to merge 3 commits into
sphinx-doc:masterfrom
jayaddison:issue-14221/singlehtml-refuri-test-coverage
Closed

Tests: add reference URI test coverage for 'singlehtml' builder#14240
jayaddison wants to merge 3 commits into
sphinx-doc:masterfrom
jayaddison:issue-14221/singlehtml-refuri-test-coverage

Conversation

@jayaddison

@jayaddison jayaddison commented Jan 4, 2026

Copy link
Copy Markdown
Contributor

Purpose

Adds test coverage to demonstrate the problem reported by @etrian-dev in #14221, and adds test coverage to:

  1. Prove that reverting singlehtml: deprecate the 'fix_refuris' helper function #13037 resolves the problem.
  2. Prevent future changes from reintroducing the problem.

References

Edit: update references list.

Specifically, check for duplication of the HTML anchor fragment
delimiter character (`#`).

Co-authored-by: @etrian-dev
@jayaddison

Copy link
Copy Markdown
Contributor Author

The unit test failures in test_singlehtml_refuris on the latest commit (2692450) are by-design, and are intended to provide coverage for bug #14221, that per this PR description, merge of #14241 will resolve.

This PR is ready for review; thank you in advance.

Chapter One
===========

This chapter discusses :term:`API` design and :term:`REST` principles.

@jdillard jdillard Aug 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason REST isn't defined? Seems it is causing warnings, without testing anything

@etrian-dev etrian-dev Aug 12, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jdillard The details are fuzzy now, but that was what let us reproduce the issue in a minimal test (#14221 (comment)). Maybe it reproduces even after adding a definition for REST.

@jayaddison

Copy link
Copy Markdown
Contributor Author

This branch has diverged from #14241, the PR that also contains a fix (a revert, essentially). I'm going to close this PR because I think that is the least-confusing way to proceed.

@jayaddison jayaddison closed this Aug 16, 2026
@jayaddison
jayaddison deleted the issue-14221/singlehtml-refuri-test-coverage branch August 16, 2026 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants