rst2pdf命令行选项全解20个参数助你高效生成PDF【免费下载链接】rst2pdfUse a text editor. Make a PDF.项目地址: https://gitcode.com/gh_mirrors/rs/rst2pdfrst2pdf 是一款开源的 PDF 生成工具口号就是「Use a text editor. Make a PDF.」——它让你用纯文本编辑器写 reStructuredTextRST文档然后直接生成排版精美的 PDF完全绕开 LaTeX 的复杂流程。本文带你一次性看懂rst2pdf 命令行选项从最常用的输出、样式表参数到页眉页脚、分页控制、图片与字体等高级选项全部 40 个参数分类拆解。读完这篇 rst2pdf 使用教程你就能熟练组合参数生成专业级 PDF 文档。快速上手一条命令生成PDF安装后生成 PDF 只需一条命令$ rst2pdf 文档名.rst 输出.pdf例如把项目里的测试文档转换为 PDF$ rst2pdf tests/input/source.rst output.pdf不确定有哪些选项随时用-h查看帮助。所有命令行参数都在源码 rst2pdf/createpdf.py 的parse_commandline()函数中定义。 上面这张图正是测试用例tests/input/test_background.yaml中通过background属性指定的页面背景说明 rst2pdf 支持整页背景图片排版。输出与配置最核心的4个参数参数作用文件名.rst 输出.pdf位置参数输入文档与输出路径可省略输出默认写 stdout-o, --output FILE指定 PDF 输出文件不能与第二个位置参数同时使用--config FILE指定配置文件默认~/.rst2pdf/config可批量预设参数默认值-s, --stylesheets FILE加载自定义样式表YAML可多次使用逗号分隔典型组合$ rst2pdf -o book.pdf -s rst2pdf/styles/dejavu.yaml 文档.rst项目自带 70 多套内置样式表位于 rst2pdf/styles/ 目录包括 A4/A5/letter 页面尺寸、dejavu字体方案、solarized-dark代码高亮主题等按需引用即可。样式与字体让PDF排版更专业参数作用--stylesheet-path DIR添加样式表搜索路径--font-path DIR添加字体搜索路径支持 TTF 和 Type1 字体嵌入--print-stylesheet打印默认样式表并退出查看内置样式的神器-l, --language LANG设置连字符与 docutils 本地化语言默认en_US--smart-quotes VALUE将 ASCII 引号、省略号、破折号转换为排版正确的形式想看看 rst2pdf 到底内置了哪些样式属性一条命令全部导出$ rst2pdf --print-stylesheet default.yaml导出的内容即 rst2pdf/styles/styles.yaml 定义的完整默认样式可作为你自定义样式表的起点。页眉页脚与分页控制出版级排版技巧参数作用--header HEADER文档未指定时的默认页眉支持###Page###、###Section###占位符--footer FOOTER文档未指定时的默认页脚--section-header-depth N页眉页脚中章节标题替换###Section###的最大深度默认 2-b, --break-level LEVEL多少级及更高层级的章节自动从新页开始默认 0--break-side VALUE章节起始页控制even/odd/any--first-page-on-right双面书籍样式正文第一页从右侧开始--blank-first-page在文档开头插入一个空白页书籍风格示例让每个一级章节都从新的一页开始页脚显示页码$ rst2pdf -b 1 --footer 第 ###Page### 页 文档.rst上图来自示例文档 doc/montecristo/montecristo.rst它正是用.. header::和.. footer::指令配合###Section###、###Page###占位符实现的页眉页脚效果。图片与内容处理DPI、脚注、表格参数作用--default-dpi NUMBER像素尺寸对象的 DPI默认 300直接影响插图大小--fit-background-mode MODE背景图适配方式scale/scale_width/center--fit-literal-mode MODE代码块超宽时的处理error/overflow/shrink/truncate默认shrink--real-footnotes脚注显示在定义处的页面底部--inline-footnotes脚注以行内方式显示--no-footnote-backlinks禁用脚注回链--repeat-table-rows跨页表格时重复表头行--inline-links链接以括号显示目标而非可点击链接--baseurl URL相对 URL 的基准地址默认当前目录测试套件中大量使用大尺寸图片如本图 1333x2000验证--default-dpi的缩放行为同一张图片DPI 设为 300 和 100 时PDF 中的物理尺寸会相差三倍。调试与进阶排查问题的秘密武器参数作用-v, --verbose打印调试信息--very-verbose打印更详细的调试信息-q, --quiet减少输出信息--version打印版本号并退出--show-frame-boundary显示页面分栏边框调试布局必备-e, --extension-module FILE加载 Python 扩展模块可自定义指令与角色--record-dependencies FILE将输出文件依赖关系写入指定文件--strip-elements-with-class CLASS从输出中移除指定 class 的元素可多次使用--raw-html支持嵌入原始 HTML--custom-cover FILE指定封面模板文件默认cover.tmpl--use-floating-images让:align:属性的图片表现更接近 rst2html--use-numbered-links章节编号时链接文字中也带上编号--date-invariant不在 PDF 中写入当前日期保证输出可复现实战调试布局问题当排版不符合预期时先打开分栏边框看看内容落在了哪里$ rst2pdf -v --show-frame-boundary 文档.rst项目内置的扩展模块示例位于 rst2pdf/extensions/ 目录可直接用-e参数加载。常用场景速查清单最小可用命令rst2pdf 文档.rst 输出.pdf压缩文件rst2pdf -c 文档.rst换字体主题rst2pdf -s rst2pdf/styles/serif.yaml 文档.rst书籍排版rst2pdf -b 1 --break-side odd --first-page-on-right 文档.rst打印就绪rst2pdf --smart-quotes 1 --repeat-table-rows --fit-literal-mode shrink 文档.rst代码库依赖追踪rst2pdf --record-dependencies deps.txt 文档.rst固定输出CI 场景rst2pdf --date-invariant 文档.rst常见问题 FAQQ1参数太多记不住怎么办A把常用参数写入~/.rst2pdf/config配置文件用--config指定其他位置命令行只传临时参数即可。Q2代码块超宽导致报错A--fit-literal-mode的默认值shrink会自动缩字号改成overflow则直接溢出显示。Q3想确认当前生效的完整默认样式A运行rst2pdf --print-stylesheet它会将 rst2pdf/styles/styles.yaml 打印到终端。Q4如何嵌入中文字体A将 TTF 字体放入某目录然后用--font-path指定该目录再在样式表中通过fontsAlias映射即可参见 rst2pdf/styles/dejavu.yaml 的写法。掌握这 40 个 rst2pdf 命令行参数你就不再需要复杂工具链——打开文本编辑器敲下rst2pdf专业 PDF 即刻生成 【免费下载链接】rst2pdfUse a text editor. Make a PDF.项目地址: https://gitcode.com/gh_mirrors/rs/rst2pdf创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考