使用auto*-指令展开和分析rst(structuretext)文档

rstparse的Python项目详细描述


rstparse包

rstparse-使用auto*-指令展开和分析rst(structuretext)文档

说明

此手动页面文档rstparse,用于解析rst的python模块 (重组文本)文件。

python及其标准库的许多文档,以及大量 的第三方模块被编写为rst(structuretext)标记文档。 rst文档更容易处理,因为类似于其他标记文档 格式,如markdown,它主要是一个纯文本文件,有几个 附加符号。

由于rst文档是纯文本文件,您可以轻松地浏览那些 使用您最喜欢的工具(例如moreless)和 lv),也可以搜索您感兴趣的主题 常用工具,如grep

但是,相当一部分rst文件使用auto指令(例如, AutoSummary、Automodule、AutoClass和AutoFunction),它们要求RST 解析器,以包含来自rst文档外部某处的内容。为了 例如,如果RST文件包含一行,

.. autosummary: good_func

此文件中不包含good_func的说明。autosummary 表示必须在此处插入说明。它是rst解析器的 识别good_func的描述存储在哪里的责任。 rstparse模块解析一个rst文件并展开所有auto*-指令。

示例

importrstparsefile='foo.rst'rst=rstparse.Parser()withopen(file)asf:rst.read(f)rst.parse()forlineinrst.lines:print(line)

安装

pip3installrstparser

可用性

pypi提供最新版本的rstparser模块 (https://pypi.org/project/rstparser/)。

另请参见

作者

Hiroyuki Ohsaki<;Ohsaki[atmark]lsnl.jp>;

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
JSON对象字段中的java MongoDB JSON数组删除   java Spring Boot@Autowired对象空指针异常   java什么时候出现内存不足?   安卓三星健康:解决java。lang.IllegalArgumentException:心率(读取)无效   tomcat java重定向301但浏览器未正确打开新url   java对象数组重复擦除   整数的JavaSpringbean注入失败   对于重复查询,JDBCforMySQL的java性能非常慢   java Entitymanager,连接太多   使用RequestDispatcher发送变量值时出现java问题   java如何禁用GWT RichTextArea拖动调整大小   JavaEclipse插件开发:如何通过代码添加默认VM参数?   java如何使用时间戳构造函数   java将两个活动JPanel层叠在一起