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

Guide to build PDF for non-ASCII language #5453

Merged
merged 1 commit into from Mar 20, 2019
Merged

Conversation

@humitos
Copy link
Member

@humitos humitos commented Mar 13, 2019

Small guide for users that want to build docs on Chinese or Japanese languages, for example.

Related to #5437

@humitos humitos force-pushed the humitos/non-ascii-pdf-docs branch from 0be1206 to 7874751 Mar 18, 2019
@humitos humitos requested a review from Mar 18, 2019
@ericholscher
Copy link
Member

@ericholscher ericholscher commented Mar 18, 2019

Doesn't this depend on the user having the feature flag enabled? Are we waiting to merge this until we remove the flag?

Loading

@humitos
Copy link
Member Author

@humitos humitos commented Mar 18, 2019

Doesn't this depend on the user having the feature flag enabled?

Yes. It depends on the flag being enabled.

Are we waiting to merge this until we remove the flag?

Not sure. I was about to add a note saying something like: "Please if you need to use this, contact the core team to enable this feature" linking to the "Feature flags" page. This way we can start promoting this more and get more projects using the flag. What do you think?

Loading

@ericholscher
Copy link
Member

@ericholscher ericholscher commented Mar 18, 2019

This way we can start promoting this more and get more projects using the flag. What do you think?

👍

Loading

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Minor grammar fix

Loading


.. _several settings that can be defined: http://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output

When Read the Docs detects that your documentation is on Chinese or Japanese it automatically adds some defaults for you.
Copy link
Contributor

@stevepiercy stevepiercy Mar 19, 2019

Choose a reason for hiding this comment

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

s/is on Chinese/is in Chinese

Loading

@stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Mar 19, 2019

@humitos or @ericholscher I would like to be a guinea pig by enabling this feature flag on Pyramid's documentation, please. We use some Unicode characters to represent a project's tree directory structure. I currently have disabled PDF builds because it fails, but I can re-enable it. Thank you!

Loading

@humitos humitos force-pushed the humitos/non-ascii-pdf-docs branch from 7874751 to 2654185 Mar 19, 2019
@humitos
Copy link
Member Author

@humitos humitos commented Mar 19, 2019

@stevepiercy I've added the flag to your project. Please try now and open a new issue to keep discussing about this if any. Thanks!

Loading


A good first try would be to use ``latex_engine = 'xelatex'`` only,
if your docs are not written in Chinese or Japanese.
This is because your build could be failing just because of an Unicode error
Copy link
Contributor

@stevepiercy stevepiercy Mar 19, 2019

Choose a reason for hiding this comment

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

Although this might be obvious to experienced folks, it is not clear that settings should be added to the project's conf.py file. I'd suggest inserting a sentence:

Edit your project's documentation configuration file ``conf.py``.
A good first try....

Loading

@stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Mar 19, 2019

@stevepiercy I've added the flag to your project. Please try now and open a new issue to keep discussing about this if any. Thanks!

Thanks @humitos! Opened #5503 to continue discussion.

Loading

@humitos humitos force-pushed the humitos/non-ascii-pdf-docs branch from 2654185 to 34aaf21 Mar 20, 2019
@ericholscher ericholscher merged commit 649b8bc into master Mar 20, 2019
1 check passed
Loading
@delete-merged-branch delete-merged-branch bot deleted the humitos/non-ascii-pdf-docs branch Mar 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants