跳转到主要内容

将reStructuredText转换为纯文本

项目描述

PyPi Status Build Status

reStructuredText在原始形式下非常易于阅读,但大量使用指令和角色可能会妨碍某些功能或使文档在原始形式下不完整(例如,.. include)。

rst2txt 允许您通过评估reStructuredText源代码并去除大部分格式来解决这个问题。最终结果是更易于阅读的文档,并删除了在纯文本文档中不合理的元素,如图像。

rst2txt 基于 Sphinx 的 TextBuilder 使用的 sphinx.writer.text.TextWriter 编写器,但去除了Sphinx特定的功能。

安装

rst2txt 可在PyPI上找到。要安装,运行

$ pip install --user rst2txt

使用方法

大多数用户只需要 rst2txt 应用程序

$ rst2txt README.rst

也可以通过编程方式调用此程序。这对于处理如README文件之类的任务可能很有用。

from docutils.core import publish_file
import rst2txt

with open('README.rst', 'r') as source:
    publish_file(source=source, destination_path='README.txt',
                 writer=rst2txt.Writer())

项目详情


下载文件

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

源代码分发

rst2txt-1.1.0.tar.gz (15.7 kB 查看哈希值)

上传时间 源代码

构建分发

rst2txt-1.1.0-py2.py3-none-any.whl (12.1 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下支持