软件简介

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等更多格式。

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (0)

加载中
更多评论
暂无内容
发表了博客
2019/03/25 15:47

为什么使用reStructuredText

经过仔细研究和比较,我终于从reStructuredText, Markdown, Wiki和Docbook中选择了reStructedText作为主要的写文档的工具。原因是: reStructuredText(简称为rst)是一个WYSIWYG的plain text文本格式。因此rst与docbook比较,易于书写和阅读。 和同样是WYSIWYG的Markdown相比,rst支持工具更加丰富一些。并且rst还在不停的演变和发展,支持的功能更多一些,例如公式和网站发布。 rst是python用以书写文档的工具。详细信息可以从h...

0
0
发表了博客
2013/07/13 11:15

Markdown 还是 reStructuredText

Markdown 还是 reST ==================== *胡言乱语,未完待续,之所以发出来是因为不想再像其他文章一样,一直在草稿箱里直到只剩删除的价值。* 什么是什么? ——————– Markdown和reST都是标记语言(markup languages)。什么是标记语言?等会儿再说。 Markdown就叫Markdown,而reST是个缩写,reST的全称是reStructuredText。 什么是标记语言? ~~~~~~~~~~~~~ 我们知道作为直接映射自然语言的文本语言在直接书写为纯文本...

1
7
发表了博客
2020/03/21 14:56

reStructuredText 入门教程

参考资料 sublime 插件安装: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/packages.html 自动补全:https://github.com/mgaitan/sublime-rst-completion 简明文档:https://iridescent.ink/HowToMakeDocs/Basic/reST.html...

0
0
发表了博客
2018/11/23 10:50

reStructuredText文件语法简单学习

reStructuredText 是一种扩展名为.rst的纯文本文件,通过特定的解释器,能够将文本中的内容输出为特定的格式 1. 章节标题 章节头部由下线(也可有上线)和包含标点的标题组合创建,其中下线要至少等于标准文本的长度 可以表示标题的符号有 =,- ,+,*,#,`,:,',",~,^,_,<,> 对于相同的符号,有上标是一级标题,没有上标是二级标题 标题最多分六级,可以自由组合使用 全加上标或者全不加上标,使用不同的6个符号的标题...

0
0
发表了博客
2019/04/30 10:37

Output text table to mysql results style, reStructuredText table style and so on

![MySQL query results table style](https://img-blog.csdnimg.cn/20190430103428178.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpaHVvcWluZ2ZseQ==,size_16,color_FFFFFF,t_70) ![reStructuredText table style](https://img-blog.csdnimg.cn/20190430103456831.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG...

0
0
发表了博客
2020/06/17 21:36

Python reStructuredText 帮助文件中文乱码

在使用 IntelliJ 对 reStructuredText 文件进行编辑的时候。 我们可能会遇到乱码的情况。 如下图: 可以看到,我们在使用 IntelliJ 的时候中文是乱码的。 这里有几个地方是需要修改的,首先你需要修改你的项目使用的是 UTF-8 编码。 Ctrl + Alt + S 进入设置,然后选择 Editor > File Encodings 你需要将你的全局设置,项目编码都设置成 UTF-8,如果你使用的是中文操作系统,可能这里默认设置是 GBK,不要使用 GBK。 然后重启你...

0
0
发表于开发技能专区
2020/06/18 20:10

Python reStructuredText 帮助文件中文乱码

在使用 IntelliJ 对 reStructuredText 文件进行编辑的时候。 我们可能会遇到乱码的情况。 如下图: 可以看到,我们在使用 IntelliJ 的时候中文是乱码的。 这里有几个地方是需要修改的,首先你需要修改你的项目使用的是 UTF-8 编码。 Ctrl + Alt + S 进入设置,然后选择 Editor > File Encodings 你需要将你的全局设置,项目编码都设置成 UTF-8,如果你使用的是中文操作系统,可能这里默认设置是 GBK,不要使用 GBK。 然后重启你...

0
0
2016/01/09 15:55

Sphinx reStructuredText 的安装

1. [安装python3.4](https://www.python.org/downloads/) 2. 下载setuptools解压找出 ez_setup.py放到python的根目录下 3. 在python目录下执行 python.exe ez_setup.py 4. 将python的scripts目录加入到环境变量中,到此目录下,执行easy_install.exe sphinx 5. 创建一个测试目录,进入该目录执行 sphinx-quickstart 6. 执行make.bat html 生成文档。 [主题](https://github.com/snide/sphinx_rtd_theme#installation)...

0
0
发表了博客
2016/06/10 00:14

用sphinx将reStructuredText文档转化成其他格式

用sphinx将reStructuredText开源书籍转化成其他格式 By qianghaohao 今天在github看到了一个项目,是用reStructuredTex标记语言写的开源书籍,然后下载下来阅读, 结果发现下载下来的目录里面有很多各种格式的文件,并不能直接阅读,需要用sphinx编译成我们 可以阅读的格式,才可以看。比如html,pdf等格式。 以下是用sphinx编译开源书籍项目:https://github.com/me115/linuxtools_rst产生html格式的全过程。 一.sphinx工具简介...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了问答
2013/08/21 19:54

reStructuredText(RST)文档中的表格制作

reStructuredText 标记语言中的表格,说明书中说是自己绘制的,请问大家真的是自己绘制的吗?这岂不是比用 Coredraw 画图还辛苦? Two syntaxes for tables: Grid tables; complete, but complex and verbose: +------------------------+------------+----------+ | Header row, column 1 | Header 2 | Header 3 | +========================+============+==========+ | body row 1, column 1 | column 2 | column 3...

1
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
0 评论
6 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部