程序员经验分享-hwhale

reStructuredText介绍

2023-05-16

文档格式编辑，目前主流最强大的要是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)快速入门语法说明，博主写得不错。

  • reStructuredText(rst)快速入门语法说明
  • Quick reStructuredText
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

reStructuredText

reStructuredText介绍 的相关文章

  • reStructuredText语法规则（官方的）

    摘自 xff1a https zh sphinx doc readthedocs io en latest rest html id48 http www pythondoc com sphinx contents html Sphinx

  • reStructuredText介绍

    文档格式编辑 xff0c 目前主流最强大的要是latex xff0c 但是语法太复杂 xff0c 环境要求也多 xff0c 有的时候也是写文档往往选择markdown xff0c 常常怀疑文档编辑的markdown不是亲生的 xff0c 很

  • reStructuredText语法简单说明

    reStructuredText 是扩展名为 rst的纯文本文件 xff0c 含义为 34 重新构建的文本 34 34 xff0c 也被简称为 xff1a RST或reST 官方网址 xff1a http docutils sourcefo

  • reStructuredText文件语法简单学习

    reStructuredText 是一种扩展名为 rst的纯文本文件 xff0c 通过特定的解释器 xff0c 能够将文本中的内容输出为特定的格式 1 章节标题 章节头部由下线 xff08 也可有上线 xff09 和包含标点的标题组合创建

  • Python Sphinx include 指令：忽略包含文件中的标头

    I found include 指令对于文本重用非常有用 相同的部分可以插入到不同的文档中 但标题级别存在问题 例如 如果我有part rst带有二级标题 part rst Header level 2 My text to be incl

  • 如何添加目录树条目？

    我正在尝试开始使用 Sphinx 来记录 Python 但我似乎缺少一些非常基本的入门步骤 我正在关注http www sphinx doc org en stable tutorial html并已安装并配置 尽可能使用默认值 该工具 问

  • 如何链接到 intersphinx 中的根页面

    我已启用sphinx ext intersphinx在我的项目中并添加了以下配置 intersphinx mapping python https docs python org 3 None pyserial https pythonho

  • Sphinx：对不同的输出格式使用不同的指令

    假设您有一个 reStructuredText 文档 并希望使用 Sphinx 2 x 将其导出为两种格式 HTML 和 PDF 您想在这两种格式中放入一些略有不同的内容 例如 文本 我是HTML 出现在 HTML 版本中 而 我是PDF

  • Python Sphinx 锚点在任意线上

    如何使用 Sphinx 在 ReST 中的任意行设置锚点引用 为了更清楚 这里有一个例子 A title with an anchor some stuff 这将创建一个标题A title with an anchor并添加一个额外的on

  • Sphinx 将代码格式添加到 :ref:

    我想向引用添加代码格式 如下所示 ref slots

  • Sphinx/reStructuredText 中的表格编辑器？

    我正在考虑使用 Sphinx reStructuredText 来编写文档 它看起来非常有前途 只是表格看起来很难做 有编辑器可以帮忙吗 Emacs 是编辑 reStructuredText 的默认 或最自然的选择 考虑到这一点桌子模式 h

  • 如何避免 ReST 表中的水平滚动条？

    我在 ReST 标记中有这个表 Option Line Kind Distinguishing Characteristic Reference The option name is call

  • RestructedText - 向链接添加标题属性

    我正在尝试在我的网站上使用从 reStructuredText 生成的 jQuery lightBox 实现 lightBox 将图像周围的链接标题作为 lightBox 显示中图像的标题 但是 我似乎无法在 reStructuredTex

  • sphinx，重组文本：表格的颜色单元格/行

    有没有办法为 sphinx 中表格中的特定行着色 我尝试使用 role 它与 CSS 文件相关 如中讨论的sphinx restructedtext 为单个单词设置颜色 https stackoverflow com questions 3

  • 将可点击的 SVG 图像插入 Sphinx 文档

    我有 SVG 图像文件 其中有多个节点 每个节点都与 URL 关联 如果我直接在浏览器中打开此文件 我可以单击每个节点 它将打开不同的 URL 但是 当我在 Sphinx 文档中使用这张图片时 它不起作用 图片作为一个整体呈现 所以我需要通

  • sphinx 使用 Latexpdf 删除 pdf 中的章节标题？

    我使用 Latexpdf 和 sphinx 生成从 rst 到 pdf 的文档 如何删除每章之前的章节标题 CHAPTER ONE 如中所述狮身人面像文档 http sphinx doc org config html你可以改变latex

  • 如何交叉引用 Sphinx 中 autodoc 生成的函数？

    我正在使用Sphinx autodoc根据我的 Python 库的文档字符串生成文档的功能 找到交叉引用的语法here http sphinx doc org markup inline html ref role 该部分之前必须有一个标签

  • 通过 :ref:? 从 ReST 文档中提取文本块

    我有一些 reStructuredText 文档 我想在在线帮助中使用其中的片段 似乎一种方法是通过引用 剪掉 标记片段 例如 my boring section Introductory prose blah blah blah my i

  • reStructuredText：README.rst 未在 PyPI 上解析

    我有一个托管在 Github 和 PyPI 上的 Python 项目 在 Github 上 https github com sloria TextBlob blob master README rst https github com s

  • reStructuredText 页面中的非 TOC 标题

    我正在使用 Sphinx 编写一些文档 有没有一种方法可以格式化页面中不成为目录一部分的标题 理想情况下 有一些反映在格式中的层次结构吗 例如 我想要做 My page TOC heading Subheading not in TOC a

随机推荐

  • 解决android studio 控制台乱码

    双击shift键 xff0c 输入vmoption xff0c 选择Edit Custom CM Options 如果没有配置过 xff0c 就会弹出窗口问是否创建配置文件 xff0c 点击Create xff0c 输入 Dfile enc

  • 无人机学习笔记

    硬件 首先从硬件开始说起把 xff0c 气压计 陀螺仪 磁力计 xff0c 这三个不用说肯定是必备的 xff0c 后面由于开发的需要还添加了激光测距 xff0c 以及光流 但是在开发过程中遇到了很多问题 xff0c 一个一个来说 气压计 气

  • 解决KEIL中ARM编译器不能编译的问题

    keil编译器出现问题 xff0c 根据提示意思就是ARM编译器选择不对的问题 Target 39 Printf 39 uses ARM Compiler 39 V5 06 update 6 build 750 39 which is no

  • linux 内核中strstr函数 功能

    在内核代码中看到strstr函数 xff1a mode 61 strstr boot command line 34 D 34 应该是一个字符串处理函数 xff0c 使用man命令查看下给出如下解释 xff1a SYNOPSIS inclu

  • KPI异常检测资料汇总

    文章目录 0 综述类1 KPI异常检测1 1 经典模型1 1 1 Donut 基于VAE的周期性无监督KPI异常检测1 1 1 1 论文解读1 1 1 2 源码分析 1 12 MAD 基于GANs的时间序列数据多元异常检测 1 2 行业落地

  • jupyter notebook：使用argparse包存在的问题及解决

    argparse模块 argparse是python用于解析命令行参数和选项的标准模块 导入argparse包 span class hljs keyword import span argparse 遇到的问题 parser 61 arg

  • Qt C++和Java相互调用

    Qt C 43 43 和Java相互调用 1 C 43 43 调用Java Test h span class token keyword class span span class token class name Test span s

  • 单片机HAL库使用HAL_UART_Receive_IT

    前言 由于本人第一次尝试开发单片机 xff0c 要实现的功能是信息转发 xff0c 需要调用HAL库方法 xff0c 中断接受信息转发给FPGA xff0c 这里没有用到DMA方式所以不做赘述 xff0c 特此记录分享希望帮到你们 发送信息

  • VLC播放gstreamer pipeline rtp流

    一 xff1a Gstreamer 下载gstreamer 编译等自行百度 pipeline命令 硬编码输出rtp gst launch 1 0 e videotestsrc 34 video x raw format 61 I420 wi

  • 【unity】Multiple plugins with the same name '...'解决方案

    Multiple plugins with the same name 39 ulua 39 found at 39 Assets Plugins uLua 1 22 x86 64 ulua dll 39 and 39 Assets Plu

  • CMAKE 环境变量

    CMAKE CXX FLAGS CMAKE C FLAGS 在cmake脚本中 xff0c 设置编译选项有两种方式 xff1a 1 1 add compile options命令 add compile options命令添加的编译选项是针

  • Gstreamer常见pipeline命令 - 持续更新中

    解码 xff1a xff08 根据码流类型自适应创建相应解码器 xff09 gst launch 1 0 filesrc location 61 home user DCIM Camera VID 20201001 103749 mov q

  • ubuntu18.04 安装包提示没有可安装候选

    sudo apt get install gcc 正在读取软件包列表 完成 正在分析软件包的依赖关系树 正在读取状态信息 完成 没有可用的软件包 gcc xff0c 但是它被其它的软件包引用了 这可能意味着这个缺失的软件包可能已被废弃 xf

  • D435在ROS下的使用

    本人电脑Ubuntu16 04 Ros 为kinetic D435可以用的ros源码下载地址 https github com intel ros realsense releases一定要仔细查看每一个版本基于的sdk的版本号 D435的

  • 在ros下使用D435出现问题ResourceNotFound: realsense2_camera

    在launch的文件内运行roslaunch rs rgbd launch出现错误 xff1a ResourceNotFound realsense2 camera 或运行 roslaunch realsense2 camera rs rg

  • 在ROS中发布ＩＭＵ数据

    本文主要是来发布sensor msgs Imu类型的消息 xff0c 其中 xff29 xff2d xff55 的数据为虚拟的 xff11 xff0e 在自己的工作空间中创建ros程序包 这个包依靠std msgs roscpp rospy

  • 控制理论学习资料

    DR CAN 傅里叶分析之掐死教程 xff08 完整版 xff09 更新于2014 06 06

  • 卡尔曼滤波原理二：扩展卡尔曼

    1 理论部分 上一篇介绍了线性卡尔曼滤波器 xff0c 当系统为线性高斯模型时 xff0c 滤波器能给出最优的估计 xff0c 但是实际系统总是存在不同程度的非线性 xff0c 如平方 三角关系 开方等 对于非线性系统 xff0c 可以采用

  • PIXHAWK添加自定义消息存储到SD卡

    四旋翼调试阶段总会出现很多难以预见的现象 xff0c 这时为了找到所出问题的原因 xff0c 就需要获得原始相关数据进行分析 xff0c pixhawk代码提供了记录飞行日志的功能 xff0c 能够将飞行中的重要数据存入SD卡中 xff0c

  • reStructuredText介绍

    文档格式编辑 xff0c 目前主流最强大的要是latex xff0c 但是语法太复杂 xff0c 环境要求也多 xff0c 有的时候也是写文档往往选择markdown xff0c 常常怀疑文档编辑的markdown不是亲生的 xff0c 很

热门标签