pythonrst怎么设置_使用rst2pdf实现将sphinx生成PDF

最新推荐文章于 2021-12-02 19:08:25 发布

weixin_39559895

最新推荐文章于 2021-12-02 19:08:25 发布

阅读量180

点赞数

文章标签： pythonrst怎么设置

本文链接：https://blog.csdn.net/weixin_39559895/article/details/111901171

版权

当初项目文档是用sphinx写的，一套rst下来make html得到一整个漂亮的在线文档。现在想要将文档导出为离线的handbook pdf，于是找到了rst2pdf这个项目，作为sphinx的拓展，然后加上少量配置即可输出中文PDF。

rst2pdf

简介

rst2pdf是一个将 reStructuredText 转换为 PDF 的工具，具有下列特性：

自定义页面布局

支持层叠样式表

支持内嵌TTF和Type1字体

支持几乎所有语言的语法高亮

使用reStructuredText作为源文件

支持字间距调整

安装

配置rst2pdf

注册到sphinx项目

需要告诉sphinx我们安装了rst2pdf，并且将其作为插件使用。只需在项目根目录下的conf.py中配置：

即可。然后，在conf.py中拷入PDF相关的配置：

具体配置项的值请自行调整，不需要严格按照我的来。

样式表

在项目根目录下创建一个zh_CN.json，写入：

关于以上样式的说明：

embeddedFonts用于嵌入字体，经试验，必须包含至少四个值才不会报错。不过这四个字体值可以是重复的。

fontsAlias用来指定各类字形用什么字体。如stdFont指正文字体，stdBold指粗体，stdItalic指斜体。其他的还有stdBoldItalic粗斜体，stdMono等宽体，等等。确保所用字体已经安装在你的操作系统上，且字体必须是TTF类型的(Windows环境下限制比较多~)。

wordWrap用于指定换行规则，CJK就是适用于中日韩文字的规则。这是从网上的模板抄来的，但经我的测试发现，如果用CJK规则的话，中英混排的文档里面英文部分就没法正常断行，这真是个遗憾。实际上，fontsAlias的分类很多都只对英文字体有意义，如严格来讲中文是没有所谓斜体的(不过因为Word的普及，经常看到中文被设置为斜体的情形)。如果是纯中文文档，当然随便用哪些中文字体都行，如宋体。现实中，经常会有中英文混排的情形，所以如果全用中文字体的话，英文部分就没法显示斜体等字形了。

关于pdf_stylesheets的说明：这个参数中默认使用的某些样式包含了一些字体，而这些字体并非在所有操作系统上都找得到。'sphinx'和'kerning'都是默认提供的样式，要么不用它们，要么直接修改其包含的字体。'a4'指设置输出的PDF为A4纸大小。默认的样式文件可以在rst2pdf的安装路径下找到。

然后配置编译脚本

Windows用户，在make.bat中加入：

if "%1" == "pdf" (

%SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The pdf files are in %BUILDDIR%/pdf.

goto end

)

类Unix用户修改Makefile:

输出PDF

然后一句：