reStructuredText(rst)简介+安装+简单说明

reStructuredText简介+安装+简单说明

reStructuredText是什么

reStructuredText是扩展名为.rst的纯文本文件,含义为”重新构建的文本“,是python编程语言的Docutils项目的一部分。简单的来说reStructuredText是一种轻量级的文本标记语言,简单易读,所见即所得的文本标记语言。简写:rst

保存格式

保存的文件通常情况下以.rst为后缀。在需要的时候.rst文件可以被转化成PDF或者HTML格式,也可以有Sphinx转化为LaTex,man等格式,现在被广泛的用于程序的文档撰写。

编辑工具

博主百度搜索了一下Sphinx 是我们要get到的工具,它允许开发人员以纯文本格式编写文档,以便采用满足不同需求的格式轻松生成输出。它使用 reStructuredText标记语法来提供文档控制,可以将 Sphinx想像成为一种文档框架:它会抽象化比较单调的部分,并提供自动函数来解决一些常见问题,比如突出显示标题索引和特殊代码(在显示代码示例时),以及突出显示适当的语法。


换件搭建

01 搭建python环境

sphinx和reStructuredText是python编程语言的一部分,所以需要先配置好Python环境。
python安装教程
python博主就这里就默认python安装好了。

02 安装setuptools

setuptools是python的一个增强工具,通过命令:pip install setuptools安装结果如下
说明博主已经安装啦
这里写图片描述

03 安装sphinx

sphinx下载地址
在命令窗口执行:easy_install.exe sphinx
结果:
这里写图片描述


04 配置环境变量

将安装python目录下scripts目录下的路径添加到Path路径下。
这里写图片描述
这里写图片描述


测试

01.

新建一个文件夹:test
这里写图片描述

02.

wind+r–>cmd —->进入到test文件下目录下
这里写图片描述

03.

输入命名:sphinx-quickstart
运行该命令会提示很多是选项,只需要在project Name后写上自己的工程名称,Authors Name后写上作者名称,其他的按默认即可。
这里写图片描述

04.

执行命令:make.bat html
这里写图片描述

05.

出现上面的效果说明转换html通过,会在该目录_build目录下生成响应的html文件,我们进入目录下的_build/html,使用浏览器打开index.html,查看页面效果。
这里写图片描述

06.

运行index.html效果如下所示
这里写图片描述

07.

说明
关于reStructuredText(rst)的简介,安装以及配置就简单介绍到这里啦。
当然既然是文本标记语言,肯定有它的语法呀,,,,那就请敬请期待博主的更新吧!!!
参考链接
https://www.cnblogs.com/gordon0918/p/5280590.html
https://blog.csdn.net/u013779449/article/details/52813957
快速入门语法说明参考

猜你喜欢

转载自blog.csdn.net/jiajikang_jjk/article/details/80305780