- 综合排序
- 最热优先
- 最新优先
- 来自专栏nummy
reStructuredtext快速入门
reStructuredText是一种reStructuredText是一种轻量级的文本标记语言，简单易读，所见即所得的文本标记语言。 其一般保存的文件以.rst为后缀。
2K20发布于 2018-08-27 - 来自专栏Python程序员杂谈
用reStructuredText来写博客(测试)
reStructuredText是什么 它是一个类似于MarkDown的标记语言，具体可参考这里：http://zh.wikipedia.org/wiki/ReStructuredText, 手册在这里
68230发布于 2019-02-28 - 来自专栏iSharkFly
Python reStructuredText 帮助文件中文乱码
在使用 IntelliJ 对 reStructuredText 文件进行编辑的时候。 我们可能会遇到乱码的情况。 如下图： 可以看到，我们在使用 IntelliJ 的时候中文是乱码的。 这是因为 reStructuredText 的插件使用了 Java 的 JavaFX 或者 Swing，这在默认情况下是不支持 UTF-8 的。 你需要对 IntelliJ 的启动参数进行设置。 https://www.ossez.com/t/python-restructuredtext/179
1.3K00发布于 2020-06-17 - 来自专栏iSharkFly
Python reStructuredText 帮助文件中文乱码
在使用 IntelliJ 对 reStructuredText 文件进行编辑的时候。 我们可能会遇到乱码的情况。 如下图： 可以看到，我们在使用 IntelliJ 的时候中文是乱码的。 这是因为 reStructuredText 的插件使用了 Java 的 JavaFX 或者 Swing，这在默认情况下是不支持 UTF-8 的。 你需要对 IntelliJ 的启动参数进行设置。 https://www.ossez.com/t/python-restructuredtext/179
1.1K00发布于 2020-06-17 - 来自专栏GopherCoder
ReStructuredText 文档编写全攻略编写文档说明
比如： scrapy 文档 scrapy.png 再比如： flask 文档 flask.png 再再比如： reStructuredText 中文文档 rst.png 再再再比如： Python-web-guide 文档即代码：即把文档的编写和 git 代码托管相一致 方便的组织结构：利用工具能很好的组织文档的结构 风格统一：风格不统一，最后项目维护起来存在巨大的沟通成本 这种文档的组织方式核心是使用了 reStructuredText 尝试从下面几个步骤讲解文档如何编写： reStructuredText 对比 markdown markdown 同样也是在程序员圈子里比较受欢迎的标记语言，大大减轻了编写文档的难度，reStructuredText reStructuredText 核心语法 作为 markdown 的重度爱好者，编写文档，真正使用的也就那些语法，同样对于 rst 也只讲解核心的几个语法点 gitbook 编写文档的流程 gitbook 格式简单 语法简单 原始的 markdown 格式有限，出现了各种扩展：比如 github 风格的 markdown rst: 适合编写复杂项目文档 契合 python 格式稍复杂于 markdown reStructuredText
6.6K31发布于 2018-06-06 - 来自专栏云深之无迹
使用Python进行数学建模(变成一本书籍)
这里再换一个： pip install sphinx pip install restructuredtext-lint 我们使用这个sphinx生成一份文档： VSCode安装这个插件 生成一份文档 reStructuredText 专为特定应用程序域的可扩展性而设计。reStructuredText 解析器是 Docutils的一个组件。 reStructuredText 是对 StructuredText和Settext轻量级标记系统的修订和重新解释。 reStructuredText 的主要目标是定义和实现用于 Python 文档字符串和其他文档域的标记语法，该语法可读且简单，但足够强大，可以轻松使用。 标记的预期目的是将 reStructuredText 文档转换为有用的结构化数据格式。
51330编辑于 2022-11-29 - 来自专栏owent
使用restructedtext编写xresloader文档
这次拖这么长时间主要是因为最近学习了一个新的文本标记语言 – ReStructuredText 。并且重新整理了Excel导表工具-xresloader工具集的文档，写文档真是好废好废时间啊。 好多项目用ReStructuredText来写文档来着，比如cmake，再比如python。然后现在有比较容易上手的readthedocs来托管文档，和github的集成也还不错。 其实ReStructuredText也支持 Markdown 。 在这些方面ReStructuredText就强大多了。不过这也是有代价的，那就是ReStructuredText的语法规则比 Markdown 复杂得多。 其实ReStructuredText很多语法规则和Markdown很想，像什么列表呀、加粗、斜体、标题啥的。不过ReStructuredText的制表，得用ascii画个表格，比较蛋疼。
60410发布于 2018-08-01 - 来自专栏iSharkFly
Python 的 RST 文件是什么
reStructuredText （ RST 、 ReST 或 reST ）是一种用于文本数据的文件格式，主要用于 Python 编程语言社区的技术文档。 从这个意义上说，reStructuredText 是一种轻量级标记语言，其设计目的是（a）文档处理软件（如Docutils）可以处理它，（b）读和写 Python 源代码的程序员很容易读它。 没有正式的 mime 类型注册为 reStructuredText，但非官方的是text/x-rst 可以将 RST 文件理解为 Python 使用的 Markup 文件就可以了。
2.7K40发布于 2020-06-17 - 来自专栏青笔原创
使用 Sphinx 给 Python 项目生成【Read the Docs】在线文档
Docs 1.1 Sphinx Sphinx 是一个强大的文档生成器，具有许多用于编写技术文档的强大功能，包括： 维护一份源文档，生成网页，可打印的PDF，用于电子阅读器（ePub）的文档等 支持 reStructuredText install sphinx 2.2 安装 Read the Docs 主题 pip install sphinx_rtd_theme * 2.3 安装 Sphinx Markdown 扩展 默认使用 reStructuredText 文档编写 Sphinx 使用 reStructuredText 作为默认纯文本标记语言。 reStructuredText 使用语法参考 reStructuredText 入门。 sphinx-rtd-theme.readthedocs.io [5] Read the Docs [6] Sphinx builtin themes [7] github imgkernel [8] reStructuredText
4K20发布于 2019-10-23 - 来自专栏木制robot技术杂谈
用Sphinx快速制作文档
本站当然也是使用 Sphinx 生成的，它采用reStructuredText! Sphinx还在继续开发. 可自动生成美观的模块索引 精确的语法高亮: 基于 Pygments 自动生成语法高亮 开放的扩展: 支持代码块的自动测试,并包含Python模块的自述文档(API docs)等 Sphinx 使用 reStructuredText 作为标记语言, 可以享有 Docutils 为reStructuredText提供的分析，转换等多种工具. Sphinx 主要功能是使用 reStructuredText, 把许多文件组织成一份结构合理的文档. toctree指令初始值如下： .. toctree:: :maxdepth: 2 你可以在
2.2K61发布于 2018-04-13 - 来自专栏nummy
sphinx入门指南【1】快速入门
丰富的扩展 结构化文档 自动索引 支持语法高亮 sphinx使用reStructuredtext作为它的标记语言。 添加内容 在sphinx源文件中，使用reStructuredText标记语言进行文档编写，除此之外，sphinx还格外提供了一些指令。 具体可以参考 reStructuredText Primer 以及 Sphinx Markup Constructs 生成文档 使用下面的命令生成文档： $ sphinx-build -b html
2.6K40发布于 2018-08-27 - 来自专栏算法与数据之美
手把手教你给项目添加文档
最后，我们只需要修改index.rst文件便可以修改文档内容，reStructuredText 是扩展名为.rst的纯文本文件，含义为"重新构建的文本"，其是轻量级标记语言的一种，被设计为容易阅读和编写的纯文本 参考资料 Quick reStructuredText：https://docutils.sourceforge.io/docs/user/rst/quickref.html Sphinx： https
1.2K10发布于 2020-03-27 - 来自专栏云深之无迹
Sphinx补篇
. ---- 在说一下Sphinx是一种工具，可以将一组reStructuredText源文件转换为各种输出格式，自动生成交叉引用，索引等。 一个reStructuredText标记元素，它可以标记具有特殊含义的内容块。指令不仅由docutils提供，而且Sphinx和自定义扩展可以添加自己的指令。 脚本已经创建了 Makefile 以及 make.bat 可以令我们更加简单的随时进行编译,只要 $ make html 这篇呢就是比较杂得一篇,属于上面文章得一个补篇.具体得这个文章还有一个语法,会讲reStructuredText
1.5K10发布于 2020-12-07 - 来自专栏Rainbond开源「容器云平台」
全栈工程师的百宝箱：黑魔法之文档篇
可以将 markdown、 reStructuredText、 textile、 HTML、 DocBook、 LaTeX、 MediaWiki markup、 TWiki markup、 OPML、 EPUB、DocBook、 GNU TexInfo、 Groff man pages、LaTeX、 ConTeXt、 LaTeX Beamer slides、PDF via LaTeX、Markdown、 reStructuredText
1K30发布于 2019-04-22 - 来自专栏人工智能LeadAI
关于深度学习框架Hamaa与Python API文档生成工具Sophon
学会使用以下工具链来发布一个完整的库： Readthedocs：文档托管 Travis-CI：集成测试托管 Codecov：代码覆盖率统计托管 Sphinx：用reStructuredText写文档 MkDocs 另外，Hamaa其实已经完成了有一个月了，之所以拖了那么久才介绍是因为： 本来是打算用Sphinx+reStructuredText写API文档的，但是如果用Sphinx+reST写API文档，就意味着和
91031发布于 2018-07-26 - 来自专栏Python无止境
Python 3.8 已发布，那如何编译和调试最新的内核源码呢？
. ├── Doc # rst(reStructuredText)格式官方文档，用其生成https://docs.python.org/ ├── Grammar # Python 参考 Directory structure reStructuredText Extended Backus–Naur form Exploring CPython’s Internals Compile
2.7K20发布于 2019-10-21 - 来自专栏云深之无迹
Sphinx初尝
本站当然也是使用 Sphinx 生成的，它采用reStructuredText! Sphinx还在继续开发. 可自动生成美观的模块索引 精确的语法高亮: 基于 Pygments 自动生成语法高亮 开放的扩展: 支持代码块的自动测试,并包含Python模块的自述文档(API docs)等 Sphinx 使用 reStructuredText 作为标记语言, 可以享有 Docutils 为reStructuredText提供的分析，转换等多种工具.
2.1K20发布于 2020-12-07 - 来自专栏Rust语言学习交流
【Rust每周一库】Tokei - 统计代码行数等信息的实用工具
0 0 Python 1943 814052 636398 58030 119624 ReStructuredText ------------------- Python 1943 814052 636398 58030 119624 ReStructuredText 0 0 Python 1943 814052 636398 58030 119624 ReStructuredText
2.2K30发布于 2019-12-25 - 来自专栏机器之心
资源 | 清华大学发布珠算：一个用于生成模型的Python库
要进行检查，在主目录中运行 pep8 . 2.文档 文档在 docs/ 目录下，是 RestructuredText（.rst）文件。主页为 index.rst。 关于 RestructuredText 的教程可参阅：https://pythonhosted.org/an_example_pypi_project/sphinx.html API References
1.2K100发布于 2018-05-08 - 来自专栏TestQA
5步搭建一个测试文档管理网站
Sphinx默认使用reStructuredText作为文档写作语言, 当然也可以通过模块支持其他格式，比如我喜欢的MarkDown格式。 当然，官方支持的reStructuredText语言，能够支持的格式会更多。比如：markdown中的表格就不被支持。
1.1K20发布于 2019-10-12
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号