使用auto*-指令展开和分析rst(structuretext)文档
rstparse的Python项目详细描述
rstparse包
rstparse-使用auto*-指令展开和分析rst(structuretext)文档
说明
此手动页面文档rstparse,用于解析rst的python模块 (重组文本)文件。
python及其标准库的许多文档,以及大量 的第三方模块被编写为rst(structuretext)标记文档。 rst文档更容易处理,因为类似于其他标记文档 格式,如markdown,它主要是一个纯文本文件,有几个 附加符号。
由于rst文档是纯文本文件,您可以轻松地浏览那些
使用您最喜欢的工具(例如more
、less
)和
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/)。
另请参见
重新构造文本标记规范
https://docutils.readthedocs.io/en/sphinx-docs/ref/rst/restructuredtext.html
structuredText指令
https://docutils.readthedocs.io/en/sphinx-docs/ref/rst/directives.html
作者
Hiroyuki Ohsaki<;Ohsaki[atmark]lsnl.jp>;