restructuredtext 相关问题

reStructuredText是一种轻量级标记语言,旨在以源格式高度可读。

在Sphinx的引用中保留内联代码

在狮身人面像中,如果我有以下标题声明:.. _somestuff:“这是代码”,这不是! =============================渲染如下:这是代码,...

回答 1 投票 36

在Sphinx / reStructuredText中添加在新标签页中打开的链接

这里是相同问题的解决方案:在reStructuredText中的新窗口中打开链接,但是,当文档中有很多链接时(尤其是当链接位于表中时,此解决方案将...

回答 1 投票 0

Django admindoc无法呈现reStructuredText

我正在使用django admindocs进行文档编制,并且基本功能运行良好(我可以访问文档页面,列出了文档文档中的模型,包括了help_text等)。不幸的是,...

回答 1 投票 3

我如何在reStructuredText(reST)中编写乘法符号?

我正在编写reST文档,这些文档将使用Sphinx呈现为HTML和PDF。我的源文件是UTF-8,并且希望我的HTML显示为UTF-8。编写...

回答 4 投票 2

如何在Sphinx中进行依赖输出格式的替换

使用Sphinx,如何根据输出格式进行替换?基本上,我想使用html:| CLICK | Unicode :: U + 21E8 elif乳胶:| CLICK | raw:...

回答 1 投票 4

为文本块应用CSS和角色,而不是在Sphinx中使用内联跨度

前面的问题解释了如何为某些reStructuredText添加颜色范围。回顾一下过程:首先,您扮演角色。 ..角色::红色使用:red:`解释后的示例...

回答 1 投票 13

我如何在python-sphinx中突出显示文本?

我正在寻找一种在python sphinx中突出显示文本的方法。我看过有关如何更改单个单词的字体颜色的文档,但是我想更改单个单词的背景颜色...。

回答 1 投票 1


Sphinx / reST:同一段中的多个匿名显式外部链接

我如何在同一段中创建两个单独的外部链接,例如:对于pytorch单击`此处 `_,对于tensorflow单击`此处 在this answer之后,使用raw-html角色代替。 添加到conf.py: rst_epilog = """ .. role:: raw-html(raw) :format: html .. |pytorch| replace:: :raw-html:`<a href="https://www.pytorch.org">here</a>` .. |tensorflow| replace:: :raw-html:`<a href="https://www.tensorflow.org">here</a>` """ 在您的.rst中: |pytorch| and |tensorflow| extlinks扩展名旨在缩短外部链接,但它也允许人们指定一个 链接描述文本 要使用它,请在conf.py中执行以下操作 # enable `extlinks` extension extensions = [ 'sphinx.ext.extlinks', ] # add external URLs extlinks = { 'pytorch': ('https://www.pytorch.org/%s', 'pytorch'), 'tensorflow': ('https://www.tensorflow.org/%s', 'tensorflow') } 现在在文档中执行以下操作: Incidentally :tensorflow:`some <>` libraries turn out to be more popular than :pytorch:`some <>` 输出应该看起来像这样 偶然地some库比some 更多>

回答 2 投票 0

如何在reST中包含另一个程序生成的内容的index.html链接

我的RST目录如下:。 |-Makefile |-构建| |-文档树| `-html | |-codecov

回答 1 投票 0

可以将Sphinx设置为根据标题编号(非文本)自动创建书签吗?

我有一个很大的错误参考手册,该手册正在转换中,以便使用Sphinx托管在readthedocs上。我希望能够根据章节号(不是...

回答 1 投票 0

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

假设您有一个reStructuredText文档,并希望使用Sphinx 2.x以两种格式导出它:HTML和PDF。您想在这两种格式中放入一些稍有不同的内容。例如,...

回答 1 投票 0

保留Sphinx Makefile代码块中的选项卡

我将Sphinx与reStructuredText输入和HTML输出配合使用,以记录基础结构的不同部分。这个想法是,阅读文档的用户可以复制示例并将其粘贴到...

回答 1 投票 1

如何在重组文本的链接内制作逐字文本? [重复]

如何在“重组文本”的链接内制作逐字文本?这是我要实现的目标:示例我尝试了以下```example`` `__```example``

回答 1 投票 2

制作PDF时如何替换Sphinx封面

我需要从RST更改Sphinx生成的Latexpdf的封面。如何在不修改Sphinx包本身的情况下做到这一点?我已经在conf文件中注意到了latex_preamble,但那只是...

回答 1 投票 1

Sphinx toctree最大深度,用于显示,但不用于导航侧栏

我想在根索引中使用这样的内容:.. toctree :::maxdepth:1 sub1 / index sub2 / index因此,仅显示顶级标题。但这也限制了导航...

回答 1 投票 0

我如何在带有Sphinx的reStructuredText中包含一个plantuml文件

我有一个具有以下内容的plantuml文件Composite.puml:包Composite {类Letter {+ __init __(char:str)#print_this_before()}并且我尝试将其包括在...

回答 1 投票 0

如何将外部文件,例如来自https://raw.githubusercontent.com/的源代码包含到.rst文件中

literalinclude可用于包含/导入本地存储库中存在的源代码或文件。是否有一种方法或指令可以从远程URL包含文件,例如https:// raw ....

回答 1 投票 0

如何输入与上一行字符数相同的连字符?

我想输入的特定字符与上一行中的字符数一样多。之前:FooBar之后:FooBar ------我想使用此函数编写reStructuredText

回答 1 投票 4

为什么无法在我的狮身人面像中搜索该短语?

我已经安装了python文档generator-sphinx,并在其中发布了一些文章,最近我发表了一篇名为股票筛选器的文章。输入筛选可以得到它。在...

回答 1 投票 3

© www.soinside.com 2019 - 2024. All rights reserved.