前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Python 的 RST 文件是什么

Python 的 RST 文件是什么

原创
作者头像
HoneyMoose
修改2020-06-17 10:19:56
2.2K0
修改2020-06-17 10:19:56
举报
文章被收录于专栏:CWIKIUSCWIKIUS

reStructuredTextRSTReSTreST )是一种用于文本数据的文件格式,主要用于 Python 编程语言社区的技术文档。

它是Python Doc-SIG(Documentation Special Interest Group)的 Docutils 项目的一部分,旨在为 Python 创建一组类似于 Java 的 Javadoc 或 Perl 的 Plain Old Documentation(pod)的工具。Docutils 可以从 Python 程序中提取注释和信息,并将它们格式化为各种形式的程序文档。

从这个意义上说,reStructuredText 是一种轻量级标记语言,其设计目的是(a)文档处理软件(如Docutils)可以处理它,(b)读和写 Python 源代码的程序员很容易读它。

reST 解析器的引用实现是 Python 编程语言中的 Docutils 文本处理框架的一个组件,但是还可以使用其他解析器。

没有正式的 mime 类型注册为 reStructuredText,但非官方的是text/x-rst

可以将 RST 文件理解为 Python 使用的 Markup 文件就可以了。

官方的使用手册,请参考链接:https://docutils.sourceforge.io/docs/user/rst/quickstart.html

目前还有一个在线的编辑环境,请参考 http://rst.ninjs.org/#Kml0YWxpY3Mq 上面的内。

你可以在上面的链接中对标记文件进行编辑。

python-rst-file-01
python-rst-file-01

在编辑的过程中,你可能还需要对 Markup 的语法有所了解。

https://www.ossez.com/t/python-rst/177

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档