跳转到主要内容

通过ReportLab将reStructured Text转换为PDF。

项目描述

https://img.shields.io/pypi/v/rst2pdf.svg https://img.shields.io/pypi/pyversions/rst2pdf.svg https://img.shields.io/pypi/l/rst2pdf.svg

rst2pdf: 使用文本编辑器。制作PDF。

从reStructuredText创建PDF的常规方式是通过LaTeX。此工具通过使用ReportLab库直接生成PDF提供了一种替代方法。

更多信息可在主网站找到。

功能

  • 用户自定义页面布局。每页多个框架,每份文档多个布局。

  • 页面切换效果

  • 层叠样式表机制,仅定义需要更改的内容。

  • 支持TTF和Type1字体嵌入。

  • 使用类指令定义任意数量的段落样式。

  • 使用文本角色定义任意数量的字符样式。

  • 自定义页面大小和页边距。

  • 使用Pygments对多种语言的语法进行高亮显示。

  • 支持嵌入几乎所有类型的位图或矢量图像。

  • 支持分词。

  • Sphinx集成

  • 完整用户手册

安装

rst2pdf支持Python 3.8或更高版本。0.99版本是最后一个支持Python 3.6和3.7的版本,0.97版本是最后一个支持Python 2.7的版本。

从PyPI安装

可以通过使用pipx从PyPI安装最新发布的版本

$ pipx install rst2pdf

rst2pdf还支持一些需要额外依赖项的功能。可以使用pipx安装所有必需的依赖项

$ pipx install rst2pdf[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]

从Snap安装

如果您正在使用支持snaps的系统,则可以使用以下命令从那里安装

$ snap install rst2pdf

从GitHub安装

在GitHub上重新开始对rst2pdf的工作,目标是添加新功能、解决未解决的问题,并且不破坏任何东西。您可以克隆存储库并安装此版本

$ git clone https://github.com/rst2pdf/rst2pdf
$ cd rst2pdf
$ git checkout <desired-branch> # if you want something other than main
$ pipx install .[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]

如果您打算对rst2pdf的源代码进行工作,请参阅doc/DEVELOPERS.rst

用法

要将reStructuredText文档转换为PDF,只需运行

$ rst2pdf <document name> output.pdf

有关可用选项的信息,请使用-h

$ rst2pdf -h

要启用与Sphinx的基本集成,修改您的conf.py文件以启用rst2pdf.pdfbuilder扩展并配置pdf_documents选项。例如

extensions = [
    # ...
    'rst2pdf.pdfbuilder',
]

# Grouping the document tree into PDF files. List of tuples
# (source start file, target name, title, author, options).
pdf_documents = [
    ('index', 'MyProject', 'My Project', 'Author Name'),
]

有关pdf_documents选项和许多其他选项的信息,请参阅手册

贡献

请参阅CONTRIBUTING

行为准则

rst2pdf是一个包容和欢迎的社区。要参与此项目,每个人都受我们社区行为准则的约束。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定该选择哪个,请了解更多关于安装包的信息。

源代码分发

rst2pdf-0.102.tar.gz (12.1 MB 查看散列值)

上传时间 源代码

构建分发

rst2pdf-0.102-py3-none-any.whl (177.1 kB 查看散列值)

上传时间 Python 3

支持者