reStructuredText介绍

本文介绍了一种比Markdown更强大的文档格式——reStructuredText,它不仅语法易于理解,而且功能丰富,可轻松转换为多种格式,如HTML和PDF。reStructuredText作为Python Docutils项目的一部分,为程序员提供了编写高质量文档的强大工具。
部署运行你感兴趣的模型镜像

文档格式编辑,目前主流最强大的要是latex,但是语法太复杂,环境要求也多,有的时候也是写文档往往选择markdown,常常怀疑文档编辑的markdown不是亲生的, 很多功能不全,而且各个的厂家的语法支持都有比较大的出入,终于找到比markdown强大的了。reStructuredText只比markdown复杂一点点,但是功能要强大很多。


下面是reStructuredText的介绍

reStructuredText 是扩展名为.rst的纯文本文件,含义为"重新构建的文本",也被简称为:RST或reST;是Python编程语言的Docutils项目的一部分,Python Doc-SIG (Documentation Special Interest Group)。该项目类似于Java的JavaDoc或Perl的POD项目。 Docutils 能够从Python程序中提取注释和信息,格式化成程序文档。
.rst 文件是轻量级标记语言的一种,被设计为容易阅读和编写的纯文本,并且可以借助Docutils这样的程序进行文档处理,也可以转换为HTML或PDF等多种格式,或由Sphinx-Doc这样的程序转换为LaTex、man等更多格式。

比如下面表格:
在这里插入图片描述

reStructuredText 和 markdown不兼容,语法上有点类似,但比markdown强大很多。

入门建议阅读reStructuredText(rst)快速入门语法说明,博主写得不错。


您可能感兴趣的与本文相关的镜像

Python3.10

Python3.10

Conda
Python

Python 是一种高级、解释型、通用的编程语言,以其简洁易读的语法而闻名,适用于广泛的应用,包括Web开发、数据分析、人工智能和自动化脚本

评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值