Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Titles in search index can contain HTML and escaped characters #13355

Open
wlach opened this issue Feb 17, 2025 · 0 comments · May be fixed by #13356
Open

Titles in search index can contain HTML and escaped characters #13355

wlach opened this issue Feb 17, 2025 · 0 comments · May be fixed by #13356

Comments

@wlach
Copy link
Contributor

wlach commented Feb 17, 2025

Describe the bug

We seem to be passing escaped HTML to the search indexer from the parser.

You can see this in the searchindex.js for the Python docs if you search for (for example) <code:

https://docs.python.org/3.14/searchindex.js

I have a PR to address this, will post.

How to Reproduce

This rst file trivially reproduces the issue:

`escaped` title with < and > in it
==================================

this document has escaped content in the title but also the characters < and > in it

Environment Information

Sphinx main as of Feb 17 2024

Sphinx extensions

Additional context

No response

wlach added a commit to wlach/sphinx that referenced this issue Feb 17, 2025
@wlach wlach linked a pull request Feb 17, 2025 that will close this issue
wlach added a commit to wlach/sphinx that referenced this issue Feb 17, 2025
wlach added a commit to wlach/sphinx that referenced this issue Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant