使用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第三方库


热门话题
java Vaadin编译小部件(插件)   java Apache Camel库是否会长期保存内存?   java什么是`。伊娃的档案?如何处理它来生成类?   如何通过反射确定Java类是否是抽象的   来自JDK 1.8.0_161的macos Java任务控制在Mac OS X上启动时冻结   java在httpSession中存储扩展对象   SpringBootApplication没有获取java@Service注释bean   java我想从具有innermap和outermap关系的hashmap创建一个hashmap?   java如何强制Eclipse链接创建完全相同类名的表?   java在pojo对象中使用映射未映射请求   java DOM W3c XML元素解析空属性   java我们可以将文本区域中的数据保存到文本文件中吗?   java如何链接首选项。xml到我的表格布局中的settingsTabFragment?   java我想设置一个私有字段来测试函数   接口中的java继承   macos我有一台mac,而java博士根本不运行我的程序   java解析时差   spring应用程序文件上传的java Jar可执行文件失败?   java向Git推送什么?