restructuredtext 相关问题

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

如何在 Toctree Sphinx 中使用替换变量?

问题在于使用替换变量 var_link,该变量在 conf.py 文件中声明如下: var_link = 'https://www.google.fr/' 该变量通过以下方式添加到 rst_prolog 中 rst_prolog = ...

回答 0 投票 0

将重组后的文本转换为 jupyter notebook

如何将重组文本(.rst 文件)转换为jupyter notebook(.ipynb 文件)? 我已经搜索并尝试了包 rst2ipynb,但是运行命令 rst2ipynb 会导致 Windows 询问我“操作...

回答 1 投票 0

在 sphinx 中创建一个与 `make latexpdf` 一起工作的角色(字体颜色)

我习惯写Rest文档,从来没有用过LaTex。 我想做的是创建一些字体颜色角色,我可以添加内联文本(例如:红色:这个文本是红色的),这些角色在 htm 中都有效......

回答 2 投票 0

Sphinx 文档制作 pdf 输出制表符行而不是单个空格?

JSON {“站点”:“站点名称字符串”, “采样率”:“”, “记录长度”: JSON {"site" : "site name string", "sampling rate" : "<data sampling rate, Hz: float>", "record length" : <data record length: float>, 我正在用 sphinx 做一些 REST 文档以获得 pdf 输出。基本上上面是我希望它在输出中的样子,但结果是这样的。我在我的代码中只使用了一个空格,但它导致它变成了制表符。 JSON {"site" : "site name: string", "sampling rate" : "<data sampling rate, Hz: float>", "record length" : <data record length: float>, 我试过在 conf.py 文件中将 tab-width 设置为 1,但没有任何效果。

回答 0 投票 0

如何在 Sphinx 中以编程方式创建文档树?

我正在创建一个生成大量 RST 文件的 Sphinx 扩展。 既然我正式知道了他们的内容,我想通过直接写docutils来获得时间和空间,skippi ...

回答 2 投票 0

RestructuredText 中的文字“*”

我正在看这段代码: def ook(*args): """一些愚蠢的功能。 :param *args: 可选参数。 """ ... 一旦我运行 Sphinx,我就会得到非常有用的错误:

回答 3 投票 0

为 Sphinx 生成的 PDF 文件添加注释的背景颜色?

我可以使用 Sphinx 指令生成笔记 .. notes::.但是,html 文件中的注释具有背景色,而生成的 PDF 中的注释则没有。 我怎样才能给狮身人面像添加颜色-

回答 5 投票 0

如何在 python 中解析重组文本?

有没有模块可以将restructured text解析成树模型? docutils 或 sphinx 可以做到这一点吗?

回答 3 投票 0

有没有办法在 reST 文本中使用 TAB 缩进?

我是 TAB 用户,使用 TAB 缩进 Python 文本和其他代码。 但是 reST 需要精确的缩进空格数, 并且空格的数量根据其上下文而不同。 他们是

回答 0 投票 0

reStructuredText 字段列表的正确缩进是什么?

我有一个包含三个字段的字段列表的文档字符串: """``DataCatalog`` 存储 ``AbstractDataSet`` 的实例。 参数: data_sets:

回答 0 投票 0

如何使用Python编程生成部分Sphinx文档?

我正在使用 Sphinx 为我的项目生成文档。 在这个项目中,我在 yaml 文件中描述了可用命令的列表,一旦加载,就会在 f...

回答 7 投票 0

Sphinx与autodoc "重复对象描述 "警告时,将成员分组到单独的文件中。

我在一个模块里有一些功能,我想在我的文档中把它们分成两组。我有三个文件:my_mod.rst my_mod =====......automodule::my_mod :no-members:......toctree::。

回答 1 投票 1

Sphinx字段列表 - url换行格式化

我正在使用 sphinx 来生成一个项目的文档。我使用的是字段列表,引用了一个很长的url。我的reST脚本如下。**Operação*^^^^^^^^^^ :Fonte: https:/google.com.br :Github: ...

回答 1 投票 0

使用sphinx指令从python中创建一个链接列表。

我有一个rst文件,其中包含: ...include::other_file.rst,other_file.rst包含了一些类似的内容。* `文本项目1 `__ * `文本项目2

回答 1 投票 5

ReST strikethrough

能否在重组后的文本中打通文本?例如,有些东西会被渲染成 标签,当转换为HTML时,就像。ReSTructuredText

回答 5 投票 47

在Python Sphinx中使用toctree时,防止子节嵌套。

我在构建Sphinx用户指南时遇到了一个问题。我想通过一个主登陆页(index.rst)来形成一个章节,其中包含章节标题和概述,然后...

回答 1 投票 13

无法让狮身人面像在toctree下链接到另一个文档上

我试图学习sphinx,但只停留在基本的例子上。我在源目录下的make html中得到了以下错误。运行Sphinx v1.1.3加载pickled环境......。

回答 1 投票 6

在Sphinx中,我怎样才能在没有大量开销的情况下创建一个可链接的 "术语 "部分?

我想创建一个 "术语 "部分,其中包含我所使用的术语的定义,这样每次我在这个术语部分使用术语时,都会创建一个指向定义的链接。...

回答 1 投票 8

在Sphinx中使用noindex与词汇表。

当使用Sphinx 1.1.3时,我如何创建一个...词汇表::条目而不显示在自动生成的索引中?我试过在四个地方使用 :noindex:。在词汇表之前和之后使...

回答 1 投票 5

VOH

我有一个像这样的斯芬克斯词汇表术语,用替换来使用下标进行正确的格式化。

回答 1 投票 1

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