Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。
我正在尝试使用带有 autodoc 和 autosummary 扩展的 sphinx 创建自动化文档。我也在使用 pydata_sphinx_theme。 我的目标是自动创建对象树...
如果我从 Markdown 构建文档（例如使用 Sphinx 并存储在公共 git 存储库中），是否可以自定义页面模板以包含页内编辑（所见即所得或 Markdown）工具...
如何添加位于 sphinx 处理文档的 docs 目录之外的 ipynb 笔记本？
我的项目有以下文件夹结构。示例中有 .ipynb 笔记本，我希望 sphinx 使用 nbsphinx 扩展名来渲染它们。 我在示例时没有遇到问题
如何在 reStructuredText 文档中交叉引用索引项？ 例如，我如何交叉引用SectionB： .. 指数：： 对：A部分； B部分 B部分 -------- B 部分
我正在尝试使用自动摘要扩展，但有一个问题，它不会在生成的表中为私有成员创建条目。我的意思通常是模块、函数等等，其名称......
我正在尝试使用 python sphinx sphinx.ext.autosummary 扩展，但有一个问题，它不会在生成的表中为私有成员创建条目。我的意思通常是模块、函数......
我尝试将谷歌的字体添加到Sphinx，这个字体在这里。到目前为止，我已尝试遵循这篇文章的说明（在评论中），并执行了以下操作： 创建一个名为 styles.css 的文件，并放置
构建 html 文档时，如何强制 sphinx 在不存在的链接上报告或创建错误？ 具体来说，我的 Python 项目中的属性和方法具有...
我正在使用 Sphinx 为 Python 程序生成 HTML 文档。 我想使用具有特定标题的通用警告指令，并以我可以定义的方式对其进行标记，例如...
我是第一次尝试使用Sphinx。我正在运行 sphinx-quickstart，但不明白提出的第一个问题： > 分离源目录和构建目录 (y/n) [n]: ... 是什么意思？
如何使用`sphinx.ext.intersphinx`链接到Python+Polars文档？
intersphinx 文档给出了一个例子： intersphinx_mapping = { 'python': ('https://docs.python.org/3', 无), } 与上面的示例类似，Polars 的正确 URL 是什么？
MyST sphinx 扩展无法识别 `{code-cell}` 指令
我正在努力让 myst_parser sphinx 扩展识别 {code-cell} 指令。 Sphinx 发出此警告： /home/dallan/Repos/bnl/myst_test/docs/index.md.rst:3：警告：未知
在`setup.py`上使用Sphinx的`BuildDoc`
我正在选择一个 Python 项目，其 setup.py 脚本中包含以下内容： 从 sphinx.setup_command 导入 BuildDoc 命令[“build_sphinx”] = BuildDoc cmd_opts["build_sphinx&qu...
我正在使用 Sphinx（v1.4.9，Windows 7 64 位上的 Python 3.5.1）编写启用了 MathJax 的文档集。 我想定义自定义 LaTeX 命令来清理我的源代码，所以我实现了这个
使用Sphinx处理第一个文件时，如何使rst_prolog中定义的替换在“`”引用的行中生效？
我在conf.py中定义了一个替换： rst_prolog = """ .. |工具|替换:: 东西 ”“” 下面是第一个文件，替换在第 1 行有效，但不...
我正在从 sphinx-doc 扩展基本主题，我注意到基本主题 layout.html 脚本宏中有以下代码块 {%- 对于 script_files 中的脚本文件 %} <p>我正在从 <a href="http://www.sphinx-doc.org/en/stable/theming.html" rel="nofollow noreferrer">sphinx-doc</a> 扩展 <a href="http://www.sphinx-doc.org/" rel="nofollow noreferrer">basic</a> 主题，我注意到基本主题中的以下代码块 <pre><code>layout.html</code></pre> <pre><code>script</code></pre> 宏</p> <pre><code>{%- for scriptfile in script_files %} <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script> {%- endfor %} </code></pre> <p>这是否意味着我可以在我的<pre><code>html_theme_options</code></pre>中添加如下所示的<pre><code>theme.conf</code></pre>：</p> <pre><code>[options] script_files = </code></pre> <p>在我的<pre><code>conf.py</code></pre>内，我添加：</p> <pre><code>html_theme_options = {'script_files': '_static'} </code></pre> <p>但是，使用此设置，构建完全混乱并产生垃圾页面，例如：</p> <pre><code><html xmlns="http://www.w3.org/1999/xhtml"> <head>...</head> <body> --> <!-- my js code but is automatically commented out--> </body> </html> </code></pre> <p>哪个部分出了问题？我应该怎么做才能加载我自己定制的 JavaScript？</p> </question> <answer tick="true" vote="6"> <p><pre><code>script_files</code></pre> 是模板内部变量。您不能通过 <pre><code>html_theme_options</code></pre> 设置它（所有主题变量都以 <pre><code>theme_</code></pre> 作为前缀，见下文）。</p> <p>Sphinx 文档在<a href="https://www.sphinx-doc.org/en/master/development/templating.html#script_files" rel="nofollow noreferrer">此处</a>解释了如何通过 <pre><code>script_files</code></pre> 变量直接在模板文件中添加其他脚本。</p> <p>如果您认为在 <pre><code>conf.py</code></pre> 中定义附加脚本很重要，请按以下步骤操作：</p> <ol> <li>将以下行添加到模板的 <pre><code>layout.html</code></pre>，例如在 <pre><code>endblock</code></pre> 定义的 <pre><code>DOCTYPE</code></pre> 下方：</li> </ol> <p><pre><code>{% set script_files = script_files + theme_extra_scripts %}</code></pre></p> <ol start="2"> <li>在<pre><code>extra_scripts</code></pre>中定义主题变量<pre><code>theme.conf</code></pre>及其默认值：</li> </ol> <p><pre><code>extra_scripts = []</code></pre></p> <ol start="3"> <li><p>覆盖<pre><code>conf.py</code></pre>中的变量：</p> <pre><code>html_theme_options = { 'extra_scripts': ['_static/test.js'] } </code></pre> </li> </ol> </answer> </body></html>
在某个地方添加 JavaScript 脚本标记，以便它适用于 Sphinx 中的每个文件
我正在使用Sphinx来写一些笔记。我在笔记中使用 Mathjax 数学扩展。数学的默认大小比我想要的要大一点。在 Mathjax 页面上我发现我可以
如何在不创建任意标签的情况下建立指向 sphinx 重构文本中标题的内部链接？
我有一个包含许多标题和副标题的文档。在正文中，我想链接回其中一个标题。如何在没有 :ref: 标签冗余的情况下做到这一点？内容好像...
Jupyter Notebook HTML 输出中带工具提示注释的 Python 源代码
我的目标是创建高质量的Python代码示例。 我使用 Jupyter Notebooks 作为笔记本中的代码示例。是否可以创建 Jupyter 笔记本本身或创建 Sphinx 文档