这是“休息罢工”的后续行动，但在斯芬克斯而不是休息的背景下。我的问题是sphinx中是否有放置“角色”指令的中心位置，或者该指令是否真的必须在sphinx文档中的每个rst文件中重复 更详细地说： 使用角色指令可以轻松定义内联文本的自定义CSS样式（请参见ReST删除线作为示例）： .. role:: custom :class: custom This is an :custom:`inline text`. 这将转换为的html呈现 .. This is an <span c

我正在使用设置一个文档。我对这个词很陌生 我的文档可以使用默认主题之一构建。一切正常：） 现在，我想定制主题。我已经更新了layout.html以符合我的皮肤。在这个模板中，我包含了globaltoc.html&localtoc.html。使用toctree（）和toc呈现toc 我想知道是否有一种方法可以更新生成的html，或者是否需要调整css以适应生成的html 谢谢 我要冒险一试，猜猜你在找什么——因为我想我也有同样的问题 例如，在localtoc.html中，模板如下所示： <h

我正在用斯芬克斯制作教材，我经常想把学生重定向到给定的手册页。Sphinx对此有一个很好的内部语法，例如：manpage:ls（1）。不幸的是，Sphinx只对此应用了一些格式，导致纯文本输出。我希望Sphinx能够呈现一个带有给定手册页的网页链接，就像对：rfc:标记所做的那样 这是可行的吗？有没有一种方法可以轻松重写：manpage:宏，这样我就可以实现这一点？我找不到任何解决方案，所以我编写了一个插件，提供：linuxman:角色并创建自定义链接，源代码可在此处找到： pypi上提供了该e

我使用sphinx生成python项目的文档，并且大量使用外部链接。我想构建html和latexpdf输出，并将其作为可点击的链接（这是默认设置），但也将生成一个PDF版本，并将其打印出来，这些链接显示在脚注中 简而言之：有没有一种方法可以像这样在.rst文件中写入外部链接： Ask a question on `my favorite Q&A website <http://stackoverflow.com/>`_. Ask a question on my favor

假设我在同一个文件夹中有两个文件a.rst和b.rst，并且a.rst如下所示 .. _foo: http://stackoverflow.com `foo`_ is a website 似乎不允许在b.rst中使用foo。有没有办法定义超链接并在多个文件中使用它们 后续行动 我使用了Steve Piercy建议的extlinks扩展。可以看到它的实现和docstring 在我的例子中，我在conf.py中定义wikipedia链接 extlinks = {'wiki': ('https:/

我正在使用Sphinx为Prolog系统实现生成文档。Prolog语言包括连接和分离控制结构，分别由复合术语（'，'）/2和（；）/2表示 但由于存在逗号和分号，以下索引指令无法生成正确的条目： 。。索引：：（'，'）/2 .. 索引：：（；）/2 到目前为止，我还无法找到角色转义的解决方案。我对Prolog也有同样的问题/0控件构造，但我通过编写以下内容找到了解决方法： 。。索引：：/0 试图使用反斜杠无效。是否支持转义我丢失的指令中的特殊字符？有没有其他解决方案可以使用（'、'）/2、（

我正在考虑将Sphinx/reStructuredText用于文档编制，它看起来非常有前途，但表看起来很难做到。是否有一个编辑器可以帮助您？如果您使用的是Mac电脑，那么它既好又简单。列表中列出了其他内容。Emacs是编辑重构文本的默认（或最自然的选择）。考虑到这一点，与reST做表格的方式非常吻合。对我来说，最好的做法是使用带插件和venv的vscode 预览插件 自动完成插件 使用Vim的矩形选择（可视块），工作起来有点简单。

我试图添加的一个文件包含许多rubric，但我发现它们有一个奇怪的错误。我一定是在做什么蠢事，但我似乎想不出来。这是我的文件： ========================== Coding Conventions ========================== Below is list of coding conventions agreed upon by ________. Please adhere to these conventions to create a more

我正在使用ablog sphinx扩展生成一个博客网站。我打开门，我现在已经找到了答案。由于该问题/答案对狮身人面像有更广泛的适用性，我想我会在这里这样问（和回答） 如何获取与html_侧栏tagcloud.html、categories.html、和archives.html内容相同的页面？我知道每个页面都有相应的生成页面，但我想要的是一个页面，它的摘要内容与侧边栏中的内容相同。我相信这样做将是一个简单的sphinx定制和模板化练习，这也是我喜欢ablog的一个重要原因——我为博客引擎学习的技

使用样式记录Python模块并使用和扩展生成html文档，我偶然发现了一个关于项目符号列表的错误（或功能？） In reStructuredText (and sphinx/numpydoc), a single-lined paragraph - with an immediately following - bullet list - is allowed, but if you have a "long" paragraph, which ma

我试图编写重构的文本标记，同时在索引中创建一个条目，并突出显示文本中提到的内容。我试过了 In this chapter, we introduce :index:`*Foo* <Foo>`, a crucial concept in this example 在本章中，我们将介绍：索引：`*Foo*`，a 本例中的关键概念 可以创建索引项，但文本将被删除 在本章中，我们将介绍*Foo*，这是本例中的一个重要概念 而不是 在本章中，我们将介绍Foo，这是本例中的一个关键概念 我能

是否仍然可以使用Sphinx在rst文件中渲染MathML 我在conf.py中启用了mathjax扩展。它与乳胶配合使用效果非常好 但是，如果我用math ML替换它，它会呈现它，但会显示所有xml代码。比如说, 产生 在Sphinx中，数学由mathjax扩展渲染。在mathjax声明中，他们支持MathML。在不知道所需输出的情况下很难回答，但是从 “math”指令插入包含数学内容的块（显示 公式、方程式）输入到文档中输入格式为LaTeX math 语法支持Unicode符号 因此，

我正在用rST/Sphinx编写一些编码教程，我想区分输入（即代码块）和输出（到终端）。因为输出也需要是文本，所以我不能简单地使用自定义类或容器，因为它们仍然会被解释，并且不能正确显示（见下文）。我如何创建一个类、容器或可以应用于文本块子集的东西 请注意，这不需要任何花哨的东西——可能只是改变“输出”块上的背景颜色，而不是我的“代码块” 我试过： 创建名为“terminal”的自定义类，但仍会对其进行解释并返回有关其内容的错误： .. container:: terminal ----

我的第一个公共Python项目现在在readthedocs（RTD）上。我正试图解决一个问题，但迄今为止没有成功 我正在使用：async:选项来标记协同路由。Sphinx2.1+支持这一点。RTD在我的项目中使用了sphinx 1.8.5。所有协同程序都只是从HTML输出中跳过，即根本没有文档记录。那太糟糕了 我在我的项目中创建了docs/requirements.txt文件，其中包含：sphinx>=2.1.0，并在RTD>admin>高级设置中输入：/docs/requirements.tx

我正在尝试获得一个下载链接，以便使用reStructuredText（reST）和Sphinx阅读文档。在reST文档中，提供下载链接的示例如下所示 。。仅限：：builder\u html 请参阅：下载：`此示例脚本'。 在本地生成html源代码时，链接会出现，但在读取文档时使用GitHub链接项目时，链接不会出现。如“读取文档”中所述，文档使用自己的名为读取文档的生成器。因此，要包含下载链接，还必须包含此生成器。比如说 .. only:: builder_html or readthedo

我正在使用Sphinx为我的Django应用程序创建文档 为了帮助/加强文档中的信息，我在根文件夹/docs/和另一个文件夹/docs/modules/中添加了自己的源文件（.rst），如下所示： docs/ abc.rst <folders1, 2 ...> modules/ about.rst extra_folder/ xyz.rst quest.rst ...... 文档

我在Python模块（vengence.directions）中有一些“常量”，我正试图使用这些常量生成合理的文档。这些“常量”的值是对象（类型：Direction），而不是文字值，并且不会生成特别有用的文档： #: North (opposite: SOUTH). NORTH = _NORTH_SOUTH.direction #: South (opposite: NORTH). SOUTH = _NORTH_SOUTH.opposite #: East (opposite: WEST).

使用时是否可以禁用完整的 我有一个派生自的类，它有许多公共方法。我的自定义类应该作为包装器工作，直接提供使用其协议与设备通信的方法。 因此，我只想在自动汇总表中包含一些选定的继承方法 .autosummary:：块完全符合我的要求，但是.autoclass:：会自动创建一个完整的方法表。有没有办法禁用此功能 编辑（澄清） 直接使用autosummary指令，我能够生成一个只包含my\u method和另一个\u method的方法表： .. autosummary:: my_method

我使用Sphinx来记录一个包含很多方法的类。我想将这些方法分组，以标题分隔，如下所示： .. autoclass:: MyClass .. automethod:: __init__ FooBar Methods -------------- .. automethod:: foo .. automethod:: bar BazQux Methods -------------- .. automethod:: baz .. au

我们在狮身人面像中有一个RST表，看起来像这样： +-------------------------+---------------------------------------------+-----------------------------------------+ | Key | Appearance in the administration | Value

我的readthedocs.org构建刚刚开始失败。。。我不知道为什么，也不是特别擅长斯芬克斯。我不明白为什么它试图为docs目录之外的需求文件构建东西，或者为什么它突然找不到这个版本的Django（或者为什么它甚至需要） 失败消息 回购 这是为了： 如果你想看看我把事情搞砸了！感谢根据，RTD正在项目根目录下解析您的，然后调用其他三个requirements.txt文件，在最新/example\u project/requirements.txt中的一个文件失败（该文件配置为您的master分

我正在写一个文档，我想包括链接到pdf文件或zip档案。如何使用rst语言和sphinx实现这一点 如果我那样做 here is a pdf file : `pdf <doc/mypdf.pdf>`_ sphinx会复制build目录中的plop.png图像。如何获得pdf或zip存档的相同行为？解决方案是使用：下载：“角色”（详细信息见） 下面是一个简短的示例，假设您在目录doc中有一个文件mypdf.pdf。目录doc和您的rst文件必须位于同一目录中： here is a p

我为Sphinx文档重新构造了文本文件，类似于： Page Title ========== **Contents** .. contents:: :local: :backlinks: none ---- Subtitle |mongodb_icon| |postgre_icon| -------------------------------------- Some totally irrelevant text here... （| mongodb|icon和| p

我在一个边缘案件中迷失了方向。我正在将一些旧的纯文本文档转换为reST/Sphinx格式，目的是从那里输出一些格式（包括HTML和文本）。一些文件化的函数是用来处理位串的，而其中的一个常见的情况是如下一个句子：起始字符是空白的“”，它具有值0。< /代码> 我试着用下面的方式把它写成一行内文：起始字符是空白的“值”0。< /代码>或“代码>开始字符是空白：文字：‘它有值0。< /代码>，但是这些结尾如何工作有一些问题： reST语法将对象直接添加到文本内部的空白处，并且不会被识别 上面的内容可

我想创建一个替代（或类似的），将一个指令转换为另一个指令 例如： 在基于sphinx的文档中，我们使用创建某些注释和警告框 然而，如果我们使用 .. note:: This is a Note 框的标题是Note，这是一个Note，成为第一段 相反，本指令 .. admonition:: This is a Note :class: note 生成具有所需标题的注释框 为了方便其他编辑器，我想创建一个替换，用第二个替换第一个 在狮身人面像中有什么可以做到的吗？是的，可以做到。您必须向S

我需要按照正确的顺序在sphinx文档的目录树中包含页面内容和一些外部链接 假设这是我的结构： ======= Test ======= .. toctree:: :hidden: Test <http:://stackoverflow.com> Some text .. include page1.rst .. include page2.rst ======= 试验 ======= .. 目录树：： ：隐藏： 试验 一些文本 .. 包括第1.1页 .. 包括

我想在Sphinx RTD站点的每个页面顶部添加一个简单的警告指令： .. attention:: The next major release of this project will launch on X date. In the meantime, we're looking for feedback. If you'd like an early preview, please reach out at someemail@someaddress.com! 最简单的方法

我想要的是在Sphinx文档中包含一个xlsx表（或者更确切地说是该文件的数据） 有没有办法将xlsx工作表转换为restructuredText？您不需要将其转换为rst。如果将xlsx工作表导出为逗号分隔文件（csv），则可以使用 最棒的是，您只需要在csv中设置一次表格，并且每当您更新xlsx工作表时，只需再次导出到csv中表格所在的位置即可 .. csv-table:: The contents of my xlsx sheet exported to mytable.csv :w

我在Sphinx reST中有一个文档集。 我在conf.py中包含了sphinx.ext.mathjax，并包含了行“mathjax_path=”。 我相信，在向rst文件添加标记之前，我只需要做这些。但是我的方程没有被渲染。比如说, :math:`a^2 + b^2 = c^2` 从浏览器中显示为 \(a^2 + b^2 = c^2\) 没有花哨的字体或任何东西。HTML是 <span class="math">\(a^2 + b^2 = c^2\)</span>

有没有办法从sphinx文档中删除包和/或模块名 示例：如果模块foo.bar中存在一个名为waa的函数，则rst代码 .. automodule:: foo.bar :members: 将产生 foo.bar.waa() 我想要输出 waa() 您可以在文件conf.py中将add_module_name更改为False： # If true, the current module name will be prepended to all description # unit

在我的StructuredText文档中，我有一个这样定义的部分： Update the ``PATH`` Environment Variable ---------------------------------------- 我想这样链接到本节： * `Update the ``PATH`` Environment Variable`_ 但是，当此代码呈现为HTML时，结果如下所示： 更新``PATH`环境变量` 我确实希望环境变量PATH以文字样式出现，但我对这一点非常陌生。有人

bot或library有没有一种好方法可以让/search命令在Slack中执行，以便通过Sphinx生成的文档进行查找 或者，是否有用于搜索（inter）sphinx的库，或者我必须将其从sphinx core中撕下？我想您可以打开文档并使用搜索框？我不太理解您的问题。@xuhdev我希望能够从slack中进行搜索，以跳过打开并单击步骤

假设我有一个斯芬克斯索引文件 .. toctree:: foo bar 而foo文档只有一个标题 *** Foo *** All about foo. 酒吧里有两个 *** Bar *** All about Bars. ****** Parrot ****** All about ex-parrots. 如果我把它编译成HTML，它将创建三个页面索引，foo和bar。但是假设我想让Parrot拥有自己的HTML页面。有没有一种方法可以在不拆分源文件的情况下实现这一点

Sphinx知道条件内容的两个指令： 仅=> ifconfig=> 它们之间有什么区别？仅此而已 only指令用于基于标记包含/排除内容标记： 在conf.py中（此用法使仅与ifconfig非常相似） 将-t标志用于sphinx build（不能用作make的标志，因为-t是-触摸make的标志） 例如：rst .. only:: draft This message only appears in drafts. .. only:: html This message

我目前正试图在Mac OS上安装Sphinx，虽然我设法解决了找不到Sphinx quickstart的问题，但现在当我想执行它时，我遇到了以下错误： usage: sphinx-quickstart [OPTIONS] <PROJECT_DIR> sphinx-quickstart: error: too few arguments 用法：sphinx快速启动[选项] sphinx快速启动：错误：参数太少 我真的不太清楚为什么它需要任何参数，因为每个教程和安装说明都表明，这个s

是否可以更改Sphinx AutoDoc生成的输出顺序 特别是，我使用：private members:指令包含私有成员。 我想要的是私有成员在输出中出现在最后，而不是第一个，这是默认值，由字母顺序和“A”前面的“u”字符引起。正如@Steve Piercy所提到的，您可以使用配置值autodoc\u member\u order设置顺序。要获得所需的行为，只需将autodoc\u member\u order='bysource'添加到您的conf.py。这将使您的文档订单与源订单相同。阅读文

我将Sphinx与StructuredText一起使用，我希望在内联文本中包含一个超链接。然而，可以预见的是，如果我写 The result has type ``Foo_ -> Bar_``. .. _Foo: Information about ``Foo``. .. _Bar: Information about ``Bar``. 然后，Foo_和Bar_不会变成超链接。如果我将文档更改为使用已解析的文本块 The result has type: .. parsed-l

使用下面的代码，我们可以创建每个在末尾包含数字的等式 \documentclass[12pt]{article} \usepackage{mathtools} \begin{document} \begin{align} 100 + x &= y \\ \frac{y}{x} &\ge 1.3 \\ (100+x)-(100+x)z &= y \end{align} \end{document} 现在用py

我有一个使用doxygen+breathe生成文档的项目设置。我使用doxygenfile指令仅显示简短而详细的文件描述，如下所示： .. doxygenfile:: DynamicArray.h :sections: briefdescription detaileddescription 我不需要其他部分，因此在这之后，我继续将函数分组到子标题下： Lifecycle --------- .. doxygenfunction:: DynamicArray_Create ..

我是斯芬克斯的新手，我似乎没有找到实现这一点的方法。我希望能够在进程中快速注释/取消注释单个目录树条目，而无需删除该行。我经常在Latex中这样做，以减少项目仍在进行时的编译时间 例如，我想实现如下目标： .. toctree:: Title 1 <file1> Title 2 <file2> Title 4 <file4> .. the comment starts here Title 3 <file3>

我想在一个jupyterbook页面上指定，这样我就可以在.rst文件中引用{func}`.myfunc`而不是{func}`mypackage.myfunc`。我有几个通过intersphinx引用的包，我只想在这个页面上使用mypackage，而不是在jupyterbook的其他页面上。有没有办法做到这一点，正确的语法是什么

Readthedocs似乎有一个奇怪的问题。构建失败没有任何明显的原因。在同一个提交ID上，生成失败一次，随后成功： 失败： 成功： 我最近的构建也失败了，它只有上一次成功提交后的额外空间： 这是发生在我的多个项目。什么问题？这是readthedocs的bug还是我的代码有问题 另请参见：是的，我在RTD的问题跟踪程序中报告了它。到目前为止没有答复。我现在有这个问题。听起来很像github.com/rtfd/readthedocs.org/issues/2591。我正在做更多的故障排除，但如

有没有办法将html徽标设置到侧边栏的中心 我环顾四周，但找不到这个选项，它存在吗？要更改Sphinx项目的HTML样式，您需要调整主题的CSS。 您可以通过在项目的conf.py文件中设置html\u style变量来引用自定义样式表来实现这一点，如Sphinx文档中所述。 您需要应用的确切CSS规则取决于您使用的HTML主题

我正在尝试实现一个问题的答案。然而，我没有成功，因为当我跑步的时候 > sphinx-autogen -o generated *.rst 我得到了错误 导入“MyMod.X”失败：没有名为MyMod.X的模块 导入“MyMod.Y”失败：没有名为MyMod.Y的模块 导入“MyMod.Z”失败：没有名为MyMod.Z的模块 在我的.rst文件中，有一个带有以下行的文件： 。。自动模块：：MyMod.X （类似地，MyMod.Y和MyMod.Z） 我正在一个子目录docs中运行这个。在

我是斯芬克斯的新手，一直在寻找解决这个问题的方法 我的索引页由Index.rst组成，其中包含目录树。该页面在正文和侧栏中显示TOC。我只想在侧边栏上显示TOC，并在每个页面正文中输入一些文本。特别是，主要的“欢迎来到我的地方”，目前index.html和index.rst应该只是一段简介，而不是TOC 我试过这个： Welcome to My Place ================== .. toctree:: :hidden: :maxdepth: 2 :capti

我正在改进一些技术文档（Sphinx），并希望在多个位置包含RST文件的内容；但是，在这样做时，RST文件被多次添加到TOC中。如何将文件包含在我想要的位置，但只引用TOC中的部分一次 以下是index.rst文件的外观： Documentation ================= .. toctree:: :maxdepth: 4 ../path/to/releasenotes.rst ../path/to/general_api_usage.rst main_c

我有一个Django网站，我创建了一个RESTAPI。在视图函数中，我有关于REST URL的文档，我想为REST URL生成API文档。视图函数如下所示： def genres(request): """ Url: /api/genres/ Parameters: None Returns: list of genres { { "id":1, "name":"action" }, {...} } """ pass 但是，当我在myprojec

我有一份有许多标题和副标题的文件。深入到文本中，我想链接回其中一个标题。如果没有：ref:标签的冗余，我如何做到这一点？内容似乎可以很好地拾取标题。我希望有这样的东西：`#轮询数据检索`重构文本支持。从： 节标题、脚注和引用自动生成超链接目标（标题文本或脚注/引用标签用作超链接名称） 因此，以下文本（摘自重构文本快速参考、拼写错误和所有内容）： 生成类似以下内容的HTML： <strong><a name="title">Titles are targets, too&l

如果我在文档中使用星号表情符号(*️⃣) 然后斯芬克斯将发出警告： WARNING: Inline emphasis start-string without end-string. 这是因为它将字符解释为一个单独的星号加上其他东西 我们如何避免这一警告 我试图避免使用literal/：samp:，因为它们在HTML输出中为字符添加了灰色背景。您可以使用反斜杠转义任何保留的重构文本标记字符： \*️⃣

Weblate对“”有详细的解释。目前，我正在使用和Github。与Wiki.js集成良好，但我更喜欢Weblate，它是一款开源的自托管应用程序 我喜欢Wiki.js如何构造文件和文件夹。Wiki.js有一个很好的内置编辑器，并且它们以md格式存储文件 虽然Sphinx与Weblate无缝集成，但我想知道Sphinx是否可以使用md文件而不是rst文件格式 我们是否也可以将Sphinx用于内部文档或保存草稿 Sphinx是否具有用户、组和权限功能 我对Wiki.js的其他替代方案持开放态度，但