sphinx中文文档在readthedocs编译PDF失败的处理
当撰写好的sphinx文档上传到github,并同步到readthedocs.org,此时会发现编译错误,这是因为默认打开到pdf和epub选项是基于LaTex的,对字体处理有要求。
解决的方法是编辑conf.py
,修改latex_elements
设置段落:
这里要注意的是,这段代码是配置LaTex,所以这些字符串必须加r,不要让pyhton解释。
所以务必检查一下几项:
不要全局导入
__future__.unicode_literals
,这会让这段代码编程unicode解释,readthedocs编译的时候会出字符问题。检查项目中全局替换的部分(例如
rst_epilog
),如果修改到源文件,那么务必手动添加u前缀,否则会出现编码错误。
参考
解决在readthedocs编译PDF含中文的问题 - 本文即转载自这片文档,测试有效
使用ReadtheDocs托管文档 - 非常详细的RedtheDocs托管介绍,建议参考
Last updated
Was this helpful?