Guide to build PDF for non-ASCII language #5453
Conversation
humitos
force-pushed
the
humitos/non-ascii-pdf-docs
branch
from
0be1206
to
7874751
Compare
|
Doesn't this depend on the user having the feature flag enabled? Are we waiting to merge this until we remove the flag? |
Yes. It depends on the flag being enabled.
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? |
👍 |
|
|
||
| .. _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. |
There was a problem hiding this comment.
s/is on Chinese/is in Chinese
|
@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 |
humitos
force-pushed
the
humitos/non-ascii-pdf-docs
branch
from
7874751
to
2654185
Compare
|
@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! |
|
|
||
| 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 |
There was a problem hiding this comment.
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....
|
humitos
force-pushed
the
humitos/non-ascii-pdf-docs
branch
from
2654185
to
34aaf21
Compare
Small guide for users that want to build docs on Chinese or Japanese languages, for example.
Related to #5437