Skip to content

Support xindy and XINDYOPTS environment variable #5476

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.

Sign up for GitHub

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

Jump to bottom
Open
humitos opened this issue Mar 18, 2019 · 8 comments
Open

Support xindy and XINDYOPTS environment variable #5476

humitos opened this issue Mar 18, 2019 · 8 comments
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code Sprintable Small enough to sprint on

Comments

@humitos
Copy link
Member

humitos commented Mar 18, 2019 •
edited
Loading

Once #5437 gets merged, we will be able to build PDF supporting non-ASCII languages. Although, there is one step missing that is to support xindy to generate the index.

Currently there are two problem for this,

  1. xindy is not installed in our docker image (Install xindy to support PDF with non-ascii indexes readthedocs-docker-images#98)
  2. when XINDYOPTS is concatenated via . in the latexmkrc file it breaks because we surround it with "" and makes the command to fail (https://github.com/sphinx-doc/sphinx/blob/25f656316828ce5797e8e887b88b314315f73493/sphinx/texinputs/latexmkrc_t#L14)
@humitos humitos added Improvement Minor improvement to code Accepted Accepted issue on our roadmap labels Mar 18, 2019
@skirpichev skirpichev mentioned this issue Mar 19, 2019
Closed
@humitos humitos mentioned this issue Mar 20, 2019
Closed
humitos added a commit that referenced this issue Mar 20, 2019
@humitos
Force to not use xindy while it's not supported
38f9d93 
When using `xelatex`, Sphinx makes xindy to be used by default.

These changes here, force to not use xindy in that case either.

This will be supported at #5476
@humitos humitos mentioned this issue Mar 20, 2019
Merged
@humitos humitos added the Good First Issue Good for new contributors label Mar 25, 2019
@shivanshu1234
Copy link
Contributor

Hello there. I have been looking into this issue but I can't find where the XINDYOPTS environment variable is being configured. Usually it is configured in the Makefile (#4454 (comment)), but the core team specifically mentioned to not use the Makefile (#4454 (comment)). Any pointer in the right direction would be appreciated.

@humitos
Copy link
Member Author

humitos commented May 4, 2019

Hi @shivanshu1234! XINDYOPTS is defined by the output of the sphinx-build latex and used in the latexmkjarc file by latexmk command.

I'm not sure yet if we can read the content of that env variable that it's added by Sphinx automatically via the Makefile (as you found) --this may need more research. Although, we can define that variable by ourselves via the admin. This is not good UX at all but that's a different problem.

Currently, the problem is that the concatenation fails even if the variable is defined from the admin and used in the process of building the PDF.

@shivanshu1234
Copy link
Contributor

@humitos Thanks for the info!

@humitos humitos added the Sprintable Small enough to sprint on label Jan 25, 2020
@astrojuanlu
Copy link
Contributor

It is my understanding that this is not a "Good First Issue"?

@humitos
Copy link
Member Author

humitos commented Sep 2, 2021

Removed!

@humitos humitos removed the Good First Issue Good for new contributors label Sep 2, 2021
@stsewd
Copy link
Member

stsewd commented Jul 29, 2024

I think we can close this now that we are moving away from overriding files on behalf of the user. Maybe we can document this.

@humitos
Copy link
Member Author

humitos commented Jul 30, 2024

This issue is still valid in the way that our environment variables include surrounding quotes (even if the user doesn't add them), which makes latexmkrc to not work as expected. So, the underlying issue is not strictly related with XINDYOPS but more with how our environment variables work.

@stsewd
Copy link
Member

stsewd commented Jul 30, 2024

We should change the title and description of the issue then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code Sprintable Small enough to sprint on
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@humitos @astrojuanlu @stsewd @shivanshu1234