如何在reStructuredText中加下划线？
在reStructuredText中，可以使用以下方法来加下划线：
- 使用单个下划线：在要加下划线的文本前后分别加上一个下划线。例如：
_下划线文本_。 - 使用多个下划线：在要加下划线的文本前后分别加上多个下划线。例如：
__下划线文本__。
下划线可以用于强调文本或创建超链接。在reStructuredText中，下划线的使用方式与其他标记语言（如Markdown）类似。
reStructuredText是一种轻量级的标记语言，用于编写文档和技术文档。它具有易读易写的特点，并且支持多种输出格式，如HTML、PDF等。reStructuredText可以用于编写项目文档、API文档、用户手册等。
推荐的腾讯云相关产品：腾讯云文档存储（COS），它是一种高可用、高可靠、低成本的云存储服务，适用于存储和管理各种类型的文档数据。您可以通过以下链接了解更多信息：腾讯云文档存储（COS）
请注意，本答案仅供参考，具体使用方法和推荐产品可能因实际需求和环境而异。
相关·内容
我有一个类方法，它的参数以下划线from_结尾，并且我正在使用autoclass为该类生成文档。我希望参数from_在我的Sphinx文档中显示为普通文本，但目前它显示为超链接。 下面是带有docstring的类方法的简化版本： class Twilio:
def get_messages(to=None, from_=None):
"""
Get messages.
`Args:`
to: str
Receiver.
from_
浏览 22提问于2020-09-26得票数 0
1回答
我搞不懂如何用标记语法把图像放进鹈鹕。
当我有这个的时候，一切都正常。
.. image:: /images/Rugby-Tackle.jpg
:alt: About to make the tackle, Yale Alumni Game 2017
但是我在.rst文档中发现了这一点。对这样的代码有很多引用：
[]({filename}/images/Rugby-Tackle.jpg)
或者这个：
浏览 2提问于2018-01-12得票数 4
回答已采纳
如何在Sublime3中设置早期键入单词的自动完成？例如，在记事本中，当我键入某项内容时，如果第一个符号匹配，则有弹出窗口。我能在崇高的3做这样的窗口吗？
谢谢
浏览 2提问于2013-10-26得票数 0
回答已采纳
我正在使用 from numpy.distutils.core import setup 用于将一些代码打包成pypi。 但是，README.md文件不能正确呈现。如果我在setuptools中使用setup，这很好用，但我不确定为什么它不能与numpy版本一起工作(我需要numpy版本来构建代码使用的一些库)。 if __name__ == '__main__':
import subprocess
try:
assert(check_python_version() )
except AssertionError:
浏览 22提问于2019-04-29得票数 0
当我试图使用RestructuredText在HTML中创建枚举子列表时，子列表不会根据我在RST中的编写方式来更改它的值。下面是我的意思的一个例子。
下面是我如何在RestructuredText中编写枚举列表和子列表：
1. Step 1
a. Step a
b. step b
2. Step 2
以下是HTML中的结果：
知道怎么解决这个问题吗？
浏览 4提问于2022-03-20得票数 0
我知道如何创建自定义文本的外部超链接。
`My cool link <http://www.asdf.com>`_
但我想链接到一个内部参考。
.. _foo:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
所以我想做像这样的事情
`My cool internal link <foo>`_
但这不管用。
浏览 1提问于2016-04-11得票数 16
我在我的项目中使用aloha编辑器2。一切正常，但我不知道如何添加/显示工具栏，以便在页面中加粗或添加表。我看到那里的文档，并了解到这件事可以通过编程来完成，但在aloha编辑器1中有一个添加工具栏的选项。
很神奇，如果aloha编辑器删除了工具栏选项，或者我可以在aloha编辑器2中显示工具栏，就像aloha编辑器1一样。
浏览 4提问于2015-06-01得票数 1
1回答
我正在使用sphinx来记录一个C++项目，其中有不同的页面来记录一个类。在这些方法中，我使用了:noindex:作为类方法，因为否则它们会扰乱整个项目索引页面。
.. cpp:function:: void foo(int a)
:noindex:
然而，这也造成了一个不同之处，那就是我不能创建本地的页面链接.在医生体内寻找另一种方法：
The first argument is the same as that to :cpp:func:`foo`.
如果没有:noindex:在foo()上，这个链接就能工作。有了它，就不会产生错误，并且会有一个链接，但是它是死/无用的/无处可去。
浏览 0提问于2020-04-13得票数 0
回答已采纳
我正在GitHub上编写文档，并希望在我的定义列表(AKA标签列表、描述列表)中建立到单个术语的散列链接。示例：https://github.com/username/projectname/wiki/SomeArticle#my-term
Kramdown提供了一个整洁的，它为定义列表中的所有术语生成元素in。但是，Kramdown不能用作GitHub wiki中的渲染器。
AsciiDoc或reStructuredText是否有类似的特性？就我所知：
AsciiDoc允许。但如果可能的话，我不想手动添加锚。
(狮身人面像驱动的) reStructuredText支持，但它似乎不适用
浏览 2提问于2020-01-18得票数 1
reStructuredTest中的超链接如下所示：
A hyperlink_ is a reference to a data.
.. _hyperlink: https://en.wikipedia.org/wiki/Hyperlink
这对于英语这样的语言非常有用，因为每个单词都被一个空格清楚地隔开了。然而，在其他一些语言中，情况可能并不总是这样。以韩语为例。
하이퍼링크는...(显然是，所以我要删除所有的CJK，除了绝对必要的部分)。
在这里，'하이퍼링크‘是一个名词，尾随的字符'는’是一个名词。问题是，如果我试图使'하이퍼링크‘这个词成为超链接，我就
浏览 5提问于2016-11-07得票数 3
我主要是在寻找一个工具，它支持从某些标记语言(reST/Markdown/纺织品)批量转换为PDF/HTML，但是.有几个条件：
标记语言必须是reST/Markdown或喜欢它们
应该有带有预览的简单编辑器(例如Gedit3 + Markdown插件之类的)
必须在多种格式之间进行批处理转换--就像Pandoc一样，但是支持完全的标记语言。
Pandoc很棒，但不幸的是它不支持reST指令( ex )。..container
现在我还不能确定哪个标记是最适合我的。我使用Markdown，因为我有相当简单的Gedit插件，可以在编写过程中预览输出。现在我正在测试狮身人面像，
浏览 0提问于2012-09-12得票数 0
1回答
我有一些reStructuredText文档。我想在在线帮助中使用它的片段。似乎有一种方法是通过引用“剪掉”标记。
.. _my_boring_section:
Introductory prose
------------------
blah blah blah
.. _my_interesting_section:
About this dialog
-----------------
talk about stuff which is relevant in contextual help
如何使用python/docutils/sphinx提取_my_interesting
浏览 3提问于2011-12-02得票数 3
在经过重组的文本中，我看到这两种方法都使用了：
`Some Link <http://www.some.com>`_
`Some Link <http://www.some.com>`__
两者从狮身人面像产生相同的输出，
对于_链接使用__还是使用双下划线__有什么区别？
你为什么要一个比另一个？
浏览 0提问于2014-12-11得票数 17
回答已采纳
如何使用实际值自定义.rst文件中的占位符？
例如，我有具有以下内容的example.rst文件：
Header
------------------------------------
${custom_text}
我希望通过运行以下命令将${custom_text}属性替换为值this is the value of custom property：
rst2html example.rst -o example.html -Dcustom_text="this is the value of custom property"
另外，我想知道是否可以使用.properti
浏览 7提问于2012-03-19得票数 0
回答已采纳
假设我在reStructuredText中有一个表，如下所示：
+---------------+---------------------------+
| key | value |
+===============+===========================+
| short_word | value_1 |
+---------------+---------------------------+
| really_long_ | value 2
浏览 0提问于2012-11-14得票数 4
回答已采纳
1回答
我在字符串中加入了这个代码：
<string name="MyunderLine"> <u> <font> the_text </font> </u></string>
从这里我如何改变下划线的颜色？
浏览 7提问于2021-12-16得票数 0
有没有可以将restructuredtext解析成树模型的模块？
docutils或sphinx能做到这一点吗？
浏览 1提问于2012-10-14得票数 25
回答已采纳
我有一个Python中的元组列表，我希望将它们输出到reStructuredText中的表中。
docutils库非常支持将reStructuredText转换为其他格式，但我想直接从内存中的数据结构写入到reStructuredText中。
浏览 0提问于2012-07-05得票数 8
回答已采纳
说“Python文档使用的标记是”。我的问题是:块注释应该如何编写才能显示多个返回值？
def func_returning_one_value():
"""Return just one value.
:returns: some value
:rtype: str
"""
def func_returning_three_values():
"""Return three values.
How do I note in reStructuredText that
浏览 0提问于2016-09-29得票数 15
如何使用reStructuredText创建链接的图像？
我找到了
.. image:: /path/to/image.jpg
用于图像和外部超链接，如
'Python <http://www.python.org/>'_
用于链接，但我不知道如何组合它们，或者这是否可能。
浏览 4提问于2012-12-30得票数 60
回答已采纳
我正在使用Sphinx来记录python项目，并尝试创建一个可重用的提示，以便在多个位置使用。
通常，我将在python文件中使用以下语法：
"""
.. tip::
I want this tip to be used in several locations. Why?
- Save time
- Work less
"""
现在，不管我把它放在文件的开头，还是在类定义下，还是在函数定义下，这都是可行的。
我找到了 for :ref:，它建议使用标签：
.. _my_reusable_tip:
浏览 2提问于2015-12-03得票数 1
回答已采纳
在谷歌上搜索了很多之后，我找不到答案。
我第一次尝试狮身人面像，我看不出如何在我的狮身人面像文档中包含到另一个页面的链接。看来，:doc指令应该能做到这一点，但它不起作用。
例如，假设我有一棵非常简单的树：
./index.rst
./files/CPPFiles.rst
./files/PythonFiles.rst
第一个是index.rst，还有一个TOC，它希望在“免费”文本中链接到这些子文件之一，所以我的index.rst包含以下内容：
My Docs
=======
This is a Python module but powered by a C++ back end.
U
浏览 2提问于2020-03-11得票数 0
回答已采纳
我的存储库有很多写有Markdown的维基页面。我希望将它们全部转换为reStructuredText，以便可以将它们编译到单独的Sphinx文档项目中。
浏览 2提问于2013-09-13得票数 0
我正在使用ReStructuredText (ReST)格式编写一些文档，以供以后使用Sphinx生成网页时使用，而且我无法找到一种方法来编写一些“粗体斜体”文本。
有所谓的“强调”(斜体)和“强强调”(粗体)文本的标记。分别为*italic text*和**bold text**。我还在一些关于这种格式的文档中看到，这些格式标记不能简单地“嵌套”。也就是说，***text*** (或** *text* **)不生成粗体斜体文本。
尽管如此，也许还是应该有一些方法来产生一份用粗体和斜体标记都强调的文本，因为用这种方式标记文本是一种普遍的做法。
浏览 3提问于2012-08-16得票数 59
回答已采纳
如果我在文档中使用了星号表情符号(*️⃣)，那么Sphinx会报错并显示警告： WARNING: Inline emphasis start-string without end-string. 这是因为它将字符解释为一个单独的星号加上其他字符。 如何避免这一警告呢？ 我尽量避免使用文字/:samp：，因为它们在HTML输出中为字符添加了灰色背景。
浏览 40提问于2020-10-04得票数 0
回答已采纳
当我创建带有参数的函数时，PyCharm为我提供了用:param param_name:字段创建docstring的功能，这非常好。但我也需要添加:type param_name:。
因此，从这一点来看：
def foo(bar, xyz):
return bar + xyz
有了generate选项，我就有了这个选项(即使在文档存根启用时插入'type‘和'rtype’也是这样的：
def foo(bar, xyz):
"""
:param bar:
:param xyz:
"""
浏览 2提问于2015-06-26得票数 28
1回答
Pycharm向我提供了下面的docstring模板：
"""
:param var1:
:param var2:
"""
用于函数def func(var1,var2)。
为什么Pycharm使用这个模板？是否有一些PEP或(不成文的)惯例认为这是好的风格？
浏览 0提问于2018-04-08得票数 1
回答已采纳
做page.find_by_id(id)的可能原因是什么，但做page.assert_selector("tr##{id}") returns aCapybara::ElementNotFound` `呢？
作为背景，我使用驱动程序实现。
我有如下结构的HTML：
<tbody>
<tr id="1234">
<td>Rico Jones</td>
<td><a href="/price_requests/5678">Price Request</a
浏览 1提问于2013-08-31得票数 1
回答已采纳
我正在将一个开源项目的文档转移到Github Pages上，但是我被困在了移动.rst文件上。
我们有一个ReadMe.rst，你可以在代码中看到。我想从我们的链接到该页面，但GitHub不会将.rst呈现为HTML，所以当您单击时，浏览器只是下载.rst文件的文本。
当然，有一些工具可以将.rst呈现为超文本标记语言，但这是一个严重的额外步骤。我们开始使用.rst的全部原因完全是因为GitHub在代码页中自动呈现它。你可能会认为有一些方法可以让Github页面实现这种自动渲染……
浏览 1提问于2013-02-26得票数 9
我使用的是，我想知道为什么它会对我的代码引发错误D407 / Missing dashed underline after section ('Example')。
我的代码如下所示：
def foo():
"""
Function description here...
Example:
Some example here...
"""
# some code here
过去，当我尝试添加Note:部分时，我也遇到过类似的问题。我不知道这是否为假阳性错误，因为我正在使用r
浏览 7提问于2021-02-28得票数 0
回答已采纳
1回答
我正在记录一个使用Sphinx和RST的C库；我希望在文档中引用一些C的内置类型来实现几个函数。例如，我想引用C的double类型。 我确实在文件的最顶端有一些配置，以确保域是C： .. default-domain:: c
.. highlight:: c 在函数定义中引用:type:`double`或:c:type:`double`可以很好地完成格式化工作，但在构建时会收到警告：Unparseable C cross-reference: 'double'。我猜这是因为我还没有像这样显式定义double的类型： .. c:type:: double 但是定义类型意味着它将
浏览 28提问于2020-07-25得票数 0
回答已采纳
在reStructuredText中有没有办法对长节标题进行换行？ 我的Linter一直抱怨超过了最大行长度，这让我发疯。 有问题的部分标题包括:any:参考，本质上不能改写为更短。 我到处搜索了RST教程，但没有找到任何与此相关的语法。 正在讨论的RST解释器是Python 3.6上的Sphinx v1.8.5。
浏览 7提问于2019-06-21得票数 3
回答已采纳
我有大量以笔记本格式存储的信息，现在我需要一种方法将其转换为 (用于另一个wiki)。
同时，我需要一个在网络上发布这些信息的可能性(但是，正如我现在所看到的，我可以使用WikidPad的“导出到HTML”选项来获得它)。
所以，主要的问题是如何在WikidPad和reStructuredText之间进行转换，反之亦然(自动快速)？
谢谢。
浏览 3提问于2012-04-27得票数 2
回答已采纳
我正在尝试将RST文件转换为Markdown文件。在一些场景中，我在几个RST文件中有类似这样的内容：
---
Copyright to XYZ
This applies in this area.
and so on
---
RST文件中虚线---文本块中的信息代表什么？我在小抄和文档中没有找到任何相关的信息。
浏览 2提问于2020-11-26得票数 1
所以这个标题已经是不言而喻的了。我正在用rst编写关于我的Python项目的文档。在使用Pycharm时，我会得到错误，所以我尝试使用另一个查看器。
我尝试了restview，但也遇到了同样的问题。
经过一番研究，我发现了我的问题这里。很明显是因为狮身人面像与众不同。所以我只需要一个查看器在本地呈现我的rst文件。
我创建了狮身人面像，但我认为，当我发现错误时，我认为这是暂时行不通的：
sphinx.errors.ApplicationError: Source directory and destination directory cannot be identical
我认为这与这有关
浏览 0提问于2020-02-05得票数 4
1回答
我正在用重新构造的文本( Sphinx页面)和Python模块中的内联文本编写代码文档。什么是拼写检查书面文档的好方法
拼写检查器将知道重新构造的文本语法，并跳过例如链接，而不是将它们突出显示为拼写错误。
拼写检查器可以与文本编辑器集成在后台运行(崇高文本)
浏览 3提问于2015-02-05得票数 2
我试图将变量列表_cities放在不同的类中，然后使用迭代器“_cities”传递它们，但在“迭代器”中显示错误。请告诉我如何在不同类的迭代器内部传递变量列表_cities？[ https://i.stack.imgur.com/kVTbj.jpg ] class romania_state {
romania_state({this.state});
List<String> state = [
"",
"Cluj-Napoca",
"Bucuresti",
];
}
class roman
浏览 12提问于2019-04-28得票数 1
当试图在rst (reStructuredText)中使用reStructuredText时，我正面临一个错误。
我已经添加了，正如中提到的，它仍然面临着这个问题
我甚至试过重新安装，但没有帮助，有人能告诉我如何解决这个问题吗？
浏览 6提问于2022-05-03得票数 2
1回答
我经常使用spyder和object检查器，我发现它作为即时帮助功能非常方便。有些模块似乎从这个功能中获益良多。例如，一个相当基本的numpy函数(numpy.absolute)在对象检查器中生成以下视图：
我想知道，我如何以这样的方式编写我自己的模块，当我在spyder中调用我的函数时，会产生如此好的视图。
浏览 1提问于2014-07-03得票数 16
回答已采纳
我可以使用什么技术或工具在RestructuredText中绘制模式图？
我不想进口png，jpeg，..为了简单的东西。
我正在寻找的是，一个RestructuredText等价于在Latex绘制，例如，。它极大地加快了文档的编写速度。
我使用rst2pdf生成文档。
浏览 5提问于2014-06-11得票数 3
回答已采纳
我用狮身人面像做文件。当我使用“”时，我从index.rst文件中得到以下警告。
如何删除这些警告？此外，由于这些警告，内容表没有在汇合中工作，但是文档正在代码中创建。
任何建议/帮助都是非常值得赞赏的。
[4px@learning-2 docs]$ make confluence
Running Sphinx v4.2.0
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [confluence]: targets for 0 so
浏览 4提问于2021-10-26得票数 2
回答已采纳
我有一份有许多标题和副标题的文件.在进一步的文本中，我想链接回其中一个标题。在没有:ref:标签冗余的情况下，我如何做到这一点？内容似乎能够很好地拾取标题。我希望能有这样的事情：`#polled-data-retrieval`_。
浏览 1提问于2013-09-05得票数 37
回答已采纳
我的文档中有两个重复的键-> .. command:: targetName在两个单独的页面上。我需要知道如何使用以下语法链接到这两个单独的目标：
Page-1 Click this -> :command:`targetName` # this will always open the first targetName declared in the doc
目标：
Page-1 Click this -> :command:`targetName <page-1.html#targetName>` # not working :/
Page-2 Click
浏览 6提问于2020-11-10得票数 0
回答已采纳
我正在尝试将我们的API文档及其专有文档生成器模式迁移到reStructuredText。给出最困难时刻的部分是，我们有一个API细节的表格表示，直接用HTML编码，一个la：
--------+------------+--------+--------------------------------+
Param | Required | Type | Description
----------------------------------------------------------------
id | Yes | int | This
浏览 5提问于2011-10-19得票数 7
回答已采纳
我有一些包含如下代码行的rst文件
.. figure:: examples/foo.png
:scale: 80%
Fig. 1 : Illustration of the awesomeness of stackoverflow
现在我想把这个文件转换成markdown。我试过用pandoc
pandoc -s -w rst --toc foo.rst -o foo.md
但是输出文件foo.md似乎忽略了图形包含行。那么，我如何才能在不失去图形的威力的情况下转换成markdown文件呢？谢谢
浏览 1提问于2012-05-27得票数 15
回答已采纳
在github中有没有办法让wiki的标题基于标记？我发现了另一个使用markdown的项目，其Home.md维基页面的标题来自于该文件。作者也可以使用web界面，并使页面的标题与标记相同。这个项目在这里：
当我尝试使用=的下划线对restructuredtext (Home.rest)做同样的事情时，标题最终被忽略，甚至不显示在呈现的页面中，使用markdown时也会发生同样的事情。
浏览 0提问于2012-06-09得票数 13
回答已采纳
不久前，我遇到了一个Python库，它将常规文本格式化为类似于Markdown、reStructuredText和纺织品的HTML格式，只是它根本没有语法。它只检测到缩进、引号、链接和换行符/段落。
不幸的是，我失去了图书馆的名字，无法搜索它。有什么想法吗？
编辑： reStructuredText，即rst == docutils。这不是我要找的:)
浏览 10提问于2008-09-22得票数 10
1回答
我在vim的RestructuredText中有一个缩进的问题。
当我编写RestructuredText (filetype=rst)时，vim会在以数字开头的行后放一些空格：
vim puts some space after line starting with a digit like even in mid sentence
9 something things are working and doing something and I need a new line to
prove my point
每次我缩进当前段落(gqip)时都会收到这个。
有什么办法可以防止"
浏览 0提问于2016-09-02得票数 2
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
