Sphinx不识别子文件夹
我是新手Sphinx。只要我的文件在source顶层文件夹中，我就能够创建HTML文档。 只要我将它们放到source directory中的子文件夹中，Sphinx就不会将文档包含到构建中。Sphinx在生成后告诉我测试文档不包括在内。因此，它可以看到该文件，但不包括它。 我错过什么了吗？我是否必须在index.rst文件或config.py中指定任何子文件夹？ 我的index
..
toctree相关内容
全部折叠：全局：-发现的文件合并到一个目录条目中
我有这样的东西： .. toctree:: :maxdepth: 2 :caption: Contents: :hidden: :glob: docs frontend backend tools/* 我希望tools目录中的所有文档都折叠到一个可展开的侧栏目录条目中。应该有可能，但我找不到任何线索。 我使用sphinx_rtd_t
..
带有toctree的自动汇总还会列出导入的成员
我使用Sphinx和autosumary来生成一个Python软件的文档。它工作得很好，但生成的.rst文件也列出了导入的函数和类，这不是我想要的行为。 例如带有文档字符串的包“Packageex”： """ Package Example (:mod:`packageex`) ================================== .. currentmodule::
..
Sphinx用于多个单独的文档
我是Sphinx的新手，在服务器上记录我的项目。现在，一位同事看到了我一直在做的事情，她想做同样的事情--在同一服务器上记录她的项目。 这些项目不相关(它们不属于单个TOC树)，我不知道如何帮助她。我可以将Shinx配置为构建单独的文档树吗？就像制作两个Makefile副本并设置不同的源/构建目录一样简单吗？ 谢谢， --TIM 推荐答案 是，我认为您希望将它们作为单独的项
..
警告：toctree包含对Sphinx不存在的文档错误的引用
几天前我开始使用Sphinx来记录一个Python包，我得到了一个似乎很常见的错误，但我找不到解决方案。 我使用了狮身人面像-快速入门来设置一切。我使用“doc/”作为文档的根位置。包含我的包的文件夹设置为： myfolder/ doc/ mypackage/ __init__.py moprob.py ... 快速入
..
在Sphinx自动汇总指令中，这个"；生成"；选项是什么？
我正在使用sphinx-apidoc和autosumary扩展来记录某个库的API，但我真的无法理解以下generated/选项的用途： .. autosummary:: :nosignatures: :toctree: generated/ module.function_1 module.function_2 ... 我见过这是Sphinx文档，并且在
..
无法在Sphinx中获取TOCTREE以显示链接
我是新来的斯芬克斯。我尝试了该教程，但未能在内容中生成链接。我收到的错误 C:Usersmhaikalmsphinxtestsourceindex.rst:11: WARNING: toctree contains refe rence to document 'intro' that doesn't have a title: no link will be generated C:Use
..
在阅读文档侧栏中显示整个目录树
我的理解是新的阅读文档主题generates the sidebar from the toctree，深度为2。我的文档相对深入，深度2是不够的。如何增加或最好完全删除此限制？ 如果这不可能，我如何使用本地目录而不是全局目录树？ 推荐答案 注意：上一个答案已过时。正如@Ariel在一条评论中指出的那样，现在可以通过在html_theme_options中设置navigation
..
如何将主页包含在Sphinx TOC中？
假设我有一个Sphinx项目，其来源如下： index.rst installation.rst templating/ index.rst module.rst fieldtype.rst index.rst(主页)具有以下目录树： .. toctree:: :titlesonly: installation templating/in
..
如何在Sphinx中展开侧栏Toctree上的所有子部分？
我想知道是否有办法展开index.rst文件中包含的标题下的所有子部分？ 作为示例，它是这样的： Section 1 Section 2 Section 3 我希望是这样的： Section 1 Subsection 1.1 Subsection 1.2 Subsection 1.3 Section 2 Subsection 2.1 Subsection
..
如何在每个页面的侧边栏中包含toctree
我正在使用Sphinx生成html文档。 如何修改文档中每个html页面的侧栏，使其包含toctree？默认情况下，目录树似乎只显示在master_doc页面中，并且只显示在主区域，而不是侧边栏。 有什么简单的方法可以做到这一点吗？我将使用ReadtheDocs来托管生成的文档，因此我倾向于避免使用任何第三方插件，除非它们在ReadtheDocs上也可用。 推荐答案 您可以在c
..
如何添加目录树条目？
我正在尝试开始使用Sphinx来记录Python，但我似乎遗漏了一些非常基本的入门步骤。 我正在按照http://www.sphinx-doc.org/en/stable/tutorial.html进行操作，并已安装并配置(尽可能使用默认设置)该工具。 问题是我无法将另一个RST文件链接到索引。我的索引文件如下： Welcome to FirstProject's documen
..
如何链接到狮身人面像目录树中的页面部分
我有一个.. toctree作为Shinx页面的一部分，其中包含指向我的包中其他rst文件的相对链接。如何包含指向给定页面的某个部分的链接，而不是整个页面本身？ 我试了一下 .. toctree:: page#section 但这并不管用。任何帮助都是很棒的。 推荐答案 经过多次修改，我得出了以下解决方案，但首先我应该声明我的目标是： 标题不出现在内容正文
..
禁用单个Sphinx警告消息
我的Sphinx树中有许多被有意从任何索引树中排除的.rst文件。我收到类似 的警告 /filename.rst:: WARNING: document isn't included in any toctree 如何在Sphinx中禁止显示特定警告？ 推荐答案 您的Sphinx项目中是否存在您不希望其内容出现在输出中的.rst文件？ 使用exclude_patterns配
..
如何在Sphinx TOC中包含`genindex‘？
Sphinx在构建文档时生成名为genindex的索引，因此forbids to use that name for a document。现在，我如何在目录中包含指向该索引的链接？ 我试过了： .. toctree:: :maxdepth: 2 genindex api Indices and tables ================== * :ref
..
Sphinx Toctree指令中的外部相对链接
我使用Sphinx构建我的文档。我正在使用其他工具作为API参考。我将我的文档放在一个目录中，其中的API引用位于目录名api中。 我希望有一个从文档到API参考的链接。我可以将链接添加到我的Toctree链接，因此： .. toctree:: :maxdepth: 1 starting glossary main-use-case-flow API R
..
Sphinx 中的条件目录树
我想做一个文档的多个版本，这些版本在包含的部分中有所不同.为了实现这一点，我通常会使用 only 指令或 ifconfig 扩展.但是，我不能将其中任何一个与 toctree 指令结合使用.p> 我基本上想要的是这样的: .. toctree:::最大深度:2介绍字符串数据类型数字.. 只有:: 大学复杂的 有没有办法做到这一点? 解决方案 如果你有目录层次结构，我之前的答案会失败，
..
如何将单个部分中的 Sphinx 章节分成不同的文件?
我正在使用出色的 Sphinx 工具来创建一些文档，并且我试图通过将同一部分的章节分成单独的文件来保持代码库的模块化形式.(参见此处了解“章节"和“部分"的定义.) 我尝试使用两个文件来做到这一点，test1.rst: ######第1部分######*********第1章*********第 1 节==========测试内容 1. 和test2.rst: *********第2章
..
如何在 Sphinx Alabaster 主题下编辑侧边栏
我有以下 index.rst 文件. 了解你数据的细胞群======================================部分内容.. toctree:::最大深度:2安装~~~~~~~~~~~~.. toctree:::最大深度:2安装脚本~~~~~~~.. toctree:::最大深度:2脚本API 文档~~~~~~~~~~~~~~~~~~.. toctree:::最大深度:2ap
..
无法让 sphinx 在 toctree 下链接到另一个文档
我正在尝试学习狮身人面像，但只停留在基本示例上.我在源目录中的 make html 出现以下错误. 运行Sphinx v1.1.3加载腌制环境...尚未创建构建 [html]:2 个过期源文件的目标更新环境:添加 2 个，更改 0 个，删除 0 个阅读资料... [100%] 介绍/home/owner/Desktop/doc/index.rst:11: 错误:“toctree"指令中的错误:无
..