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

[bugfix] SubstitutionDefinitionsRemove: only run for LaTeX builder #8865

Merged
merged 1 commit into from Feb 10, 2021

Conversation

brechtm
Copy link
Contributor

@brechtm brechtm commented Feb 10, 2021

My PR #8183 includes an oversight that makes it have no effect. The post-transform was still applied when using builders other than the LaTeX builder. This fixes it.

I noticed that also IndexInSectionTitleTransform is being applied for all builders. Perhaps that should be limited to the LaTeX builder as well?

@tk0miya tk0miya added this to the 3.5.0 milestone Feb 10, 2021
@tk0miya tk0miya changed the base branch from 3.4.x to 3.x February 10, 2021 15:30
@tk0miya tk0miya merged commit 52e9048 into sphinx-doc:3.x Feb 10, 2021
@tk0miya
Copy link
Member

tk0miya commented Feb 10, 2021

Thanks!

I noticed that also IndexInSectionTitleTransform is being applied for all builders. Perhaps that should be limited to the LaTeX builder as well?

I'll fix it on another PR.

@jessegv
Copy link

jessegv commented Apr 1, 2021

@brechtm @tk0miya I was having a "search" issue. I narrowed it down to this PR. If I revert this commit, then my issue is fixed, even on master. The issue I was having was if I do a search for a keyword, the search results will show up in what looks like all my files, when in fact it should only be in 1 file. Perhaps this SubstitutionDefinitionsRemove function "should" be run even for html builder. Do you confirm same behavior?

@brechtm
Copy link
Contributor Author

brechtm commented Apr 1, 2021

@jessegv Thanks for reporting. When you say you search for a keyword, is that keyword a word you used in a substitution? Is this substitution definition included in the rst_prolog/rst_epilog? A minimal Sphinx project (along with the search term) showing this issue would be very helpful. You can open a new issue for this.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants