我正在尝试在主目录树上创建一个条目，其中包含三个嵌套条目，每个条目链接到一个页面（因为我们的主目录已经很长了）。 结构是这样的： Layers是layers.rst并且Using Layers是layers.rst中的一个标题。 我在layers.rst中为层 Arguments和层列表创建了另外 ...
我有第一个文件，例如： 这导致目录树 有没有办法从目录树中删除第 1 Section1和Section2 2 节 - 我想要其中，只有我明确说明的内容 ...
如果我在index.rst有以下index.rst ： 然后“本节”将在生成的 HTML 文件中出现两次：一个作为<h1> ，一个作为<p class="caption"> 。 我怎样才能摆脱后者，或者让:caption:生成一个<h1> ？ 我不能简单地删除 ...
我有这个源目录结构： 这是我的index.rst ： 这是我的python.rst ： 我的conf.py ： 在做sphinx-build -b html source build之后，我得到了 index.html, python.ZFC35FDCet80D5FC67D532E... 我有这个 ...
我是狮身人面像的新手，我似乎没有找到实现这一目标的方法。 我希望能够随着我的进步快速评论/取消评论单个目录树条目，而不必删除该行。 我曾经在 Latex 中执行此操作，以减少我的项目仍在进行中的编译时间。 例如，我想实现这样的目标：.. toctree:: file1 file ...
有没有在 sphinx-autosummary toctree 中使用标签的选项？ Sphinx 可以构建一个目录树，例如： 以上将在 HTML 文档的 TOC 中显示“Main page”。 我也想使用自动摘要目录树 但是，上面的 label 产生： module\main.rst: WARNI ...
我有这样的事情： 我希望在tools目录中找到的所有文档都折叠到一个可扩展的侧边栏目录条目中。 应该有可能，但我找不到线索。 我使用sphinx_rtd_theme 。 换句话说：假设我有一个像这样的很长的文档（ tools.rst ）： 我应该如何按小节拆分它并保留文档结构，而不求助于包含，无论如 ...
假设我有： 我的sphinx-doc源文件夹的根 ( source ) 中的foo0.rst文件， source的子文件夹subfolder1中的foo1.rst文件， subfolder1 的subfolder1文件夹subfolder2中的foo2.rst文件， 那是： 都具有相同的内容： ...
我在我的 sphinx 项目中使用了一个带有 glob 选项的 toctree，我想显示与我的文件的 H1 不同的标题或使用 Titlesonly 作为 toctree 选项的文件名。 这是我的代码的快照： 在 index.md 中有我项目的 README.md 文件 我想显示“项目根目录” ...
我在Sphinx 中使用toctree自动生成网页的目录。 它创建（大致）： 第一的 第二 第三 我想要数字，但我不想要子弹。 是否有一些我遗漏的魔法可以让我得到没有项目符号的枚举列表？ ...
我正在尝试使用 Sphinx 的基础知识来记录一个小项目。 但我无法让他找到上面目录中的文件。 项目结构如下： /用户/机器/工作区/project1 而且我尝试以多种方式配置 index.rst ，但均未成功： 我还结合了几次尝试，将 sys.path.insert() 添加到项目目录中。 如 ...
我想在我的目录树中添加一个下载链接的项目符号列表。 理想情况下，它看起来像这样： 富示例下载 foo.py 文件下载 foo.ipynb 文件酒吧示例下载 bar.py 文件下载 bar.ipynb 文件我试过了： 但这失败了，因为toctree只需要对文档的引用： 我最接近的是： 看起来像这样： ...
尝试使用 Sphinx 生成文档。 首先使用： sphinx-apidoc然后使用： sphinx-build html 我收到了关于modules.rst文件的警告。 该文件存在，html 也生成了，它看起来绝对像一个目录。 我阅读了我能找到的关于该主题的所有主题，但没有一个能解决问题（使用 .. ...
我正在 Sphinx 中开发文档，并想使用水平条分隔目录中的部分。 我经常在菜单中看到这个： 有没有办法在狮身人面像中做到这一点？ ...
我有一个具有以下结构的Sphinx文档： 当我基于此渲染 HTML 时，一切都按预期进行 - 我有本章的起始页，我的子章节可从侧面菜单中获得。 但是，当我构建我的 LaTeX/PDF output 时，层次结构在目录和编号中如下所示： 我想要的如下： 或者： 我意识到这可能是试图“破解” toctr ...
我正在编写用于生成 html 和 latex output 的 sphinx 文档。 我的一些rst文件的结构如下： 这在我的 html output 中按预期工作 - 但对于我的 latex 构建，我在构建我的 Z41440717EZB4171 时得到以下命令： 预期的顺序如下： 有没有办法通过c ...
我的 RST 目录如下所示： 在我的 index.rst 中，我想创建一个名为 Code Coverage 的相对链接，指向codecov/index.html 。 我不知道该怎么做，因为它在我的源文件夹之外。 当我在 python 中运行代码覆盖率时，'codecov' 文件夹是自动生成的。 ...
我正在尝试使用sphinx.ext.autosummary来记录 Python 包。 由于“自动摘要”要求我们列出要包含的所有项目，因此我想使用 Jinja2 指定这些项目。 我的conf.py如下（相关部分如图）： rstjinja()和setup()是从这里借用的。 它明确指出： ...
我正在尝试学习如何管理与其他内容位于同一文件中的toctree元素。 假设我有一个看起来像这样的 thingamajig.rst 章节： 当我渲染它 --- foo/bar/baz 有自己的 .rst 文件 --- 它看起来像这样： 但是如果我在 toctree之前移动Overview部 ...
好的，我正在使用 Sphinx Autosummary 为某些类生成文档。 有三种不同类型的类，我希望我的侧边栏具有三个不同的部分，就像我在 toctree 指令中使用 :caption: 选项一样。 所以我添加了将我的自动摘要指令分隔为三个较小的指令，并在它们之间放置了一个隐藏的目录树，如下所示 ...