程序员经验分享-hwhale

构建失败 Sphinx 错误内容.rst 未找到

2024-03-27

我按照阅读文档的说明进行操作，但收到此错误：

bash Sphinx 错误：主文件 /home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents.rst 未找到

您必须阅读 docs yaml 文件吗？


如果你有自己的conf.py文件，它会覆盖读取文档的默认值conf.py。默认情况下，Sphinx 期望主文​​档是contents。阅读文档将主文档设置为index相反（或您在设置中指定的任何内容）。尝试将其添加到您的conf.py:

master_doc = 'index'

欲了解更多信息，请查看此问题：https://github.com/rtfd/readthedocs.org/issues/2569 https://github.com/rtfd/readthedocs.org/issues/2569

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

ReadTheDocs

构建失败 Sphinx 错误内容.rst 未找到 的相关文章

  • VScode+Sphinx+ReadTheDocs 从环境搭建到放弃

    概述 此篇博客用来记录在windows10中配置环境的过程 xff0c 注意是Windows下 xff0c 我没有在Linux下面尝试过配置 一下参考了各路教程加上自己亲测 xff0c 应该是没有问题的 被掏空 目录 概述 目录材料清单工具

  • Python Sphinx autodoc 未在 readthedocs 上呈现

    我有一个托管在 Github 上的 Python 包 名为spike2py 我已经使用 Sphinx 和 rst 文件准备了我的文档 这些文件托管在 GitHub 上here 我能够成功运行make html本地并获得所需的输出 也就是说

  • 阅读文档 Sphinx 版本中不包含文档字符串

    我构建了 Sphinx 文档 并且该构建在本地运行良好 我的文档字符串如下所示 当移动到 readthedoc io 时 我在下面添加了一个特定的要求文件docs requirement txt这是 sphinx 3 5 4 sphinx

  • readthedocs 不从公共 github 存储库创建文档

    我有一个公共 github 存储库 下列的指示在 readthedocs 中 我使用 Sphinx 以我很乐意让其他人看到的形式获取文档 编辑文件并重建 直到您喜欢所看到的内容为止 然后提交更改并推送到公共存储库 一旦您在公共存储库中拥有

  • 如何在制作 htmlhelp 时使用 Sphinx RTD 主题隐藏侧边栏

    使用时是否可以隐藏侧边栏Sphinx与ReadTheDocs theme 再扩展一下问题 我可以在发出命令时包含侧边栏吗 制作 html 并且不包括它发出命令 制作 htmlhelp 不改变代码 也许在layout html 中添加一些东西

  • 我在阅读文档上构建项目时遇到问题

    使用 sphinx quickstart 创建了 sphinx 项目 运行 make html 并且没有产生错误 将所有代码推送到 GitHub 我尝试在阅读文档上导入和构建项目 但出现以下错误 我在使用 Mac 时没有遇到任何问题 它在阅

  • python readthedocs如何满足sip（或pyqt）的要求

    我想发布我的项目的文档https bitbucket org oaltun opn在 readthedocs org 中 构建失败 日志中显示不同的错误https readthedocs org builds opn 2247789 但第一

  • 在 ReadTheDocs 上使用自定义主题

    我尝试使用从 Sphinx 的内置 ReadTheDocs 主题继承的自定义主题 当我在本地计算机上使用它时 我有很好的设计 但是当我阅读文档版本 从 gi thub 导入 时 没有 CSS 我错过了什么 使用自定义主题的分支的存储库 ht

  • Github 中的“blob”对应什么？

    下面 URL 中 blob 后面的单词指向给定存储库的 master 分支 https github com celery celery blob master docs django first steps with django rst

  • 如何在 Sphinx 运行时预处理源文件？

    我已经为我的项目设置了 Sphinx 文档 并希望提取源文件的文档字符串并将它们嵌入到最终文档中 不幸的是 Sphinx 不支持源文件的语言 VHDL VHDL 似乎没有 Sphinx 域 所以我的想法如下 挂钩 Sphinx 运行并在 S

  • 阅读不使用 automodule 的文档

    我已经为我的项目编写了一些文档 在 Python 文档字符串中 并在我的本地计算机上使用 Sphinx 测试了所有内容 一切正常 所有导入工作正常等等 所以我在阅读文档上设置了一个自定义环境 Python 3 numpydoc和我的图书馆

  • 如何为 reStructuredText、Sphinx、ReadTheDocs 等设置自定义样式？

    我想扩展使用的主题Sphinx and 阅读文档与我自己的自定义样式 为了让我的更改得以保留 最好的方法是什么 编辑 截至 2021 年 以下答案已过时 请使用html css files 在你的conf py而不是使用版本 1 8 之后的

  • ReadTheDocs 和 autodoc 在构建期间无法找到我的包

    我一直在尝试在 readthedocs 上为我的第一个 python 包 QutiePy 构建文档 在本地构建文档工作正常 但是当我尝试在 readthedocs 上构建时 autodoc 无法填充我的部分并给出以下警告 WARNING a

  • 是否可以使用 sphinx-apidoc 在同一 git 存储库中为多个包创建文档？

    我有一个 git 存储库 其中包含多个遵循命名空间的包 即PEP 420 https www python org dev peps pep 0420 我正在尝试使用 Sphinx 创建 ReadTheDocs 文档 git 存储库看起来像

  • 使用私有 git 存储库来阅读文档

    我安装了 read the docs 以从需要用户 密码身份验证的私有 git 存储库上的项目开始生成文档 手动导入项目时 如何输入用户名和密码以允许阅读文档克隆存储库 非常感谢 最大限度 我最近遇到了同样的问题 这里还有一个这样的问题为什

  • 如何避免 ReST 表中的水平滚动条？

    我在 ReST 标记中有这个表 Option Line Kind Distinguishing Characteristic Reference The option name is call

  • 如何在 RST/阅读文档的代码块中添加复制按钮

    我一直在编写个人 操作方法 指南 记录并保留我的学习日记 我现在有一个几乎太长的代码块 当我自己遇到这么长的代码时 试图仅突出显示该代码块而不突出显示整个页面 或者还不够 总是令人沮丧 所以 我的问题是 对于rst 重构文本 code bl

  • 构建失败 Sphinx 错误内容.rst 未找到

    我按照阅读文档的说明进行操作 但收到此错误 bash Sphinx 错误 主文件 home docs checkouts readthedocs org user builds mybinders checkouts latest docs

  • 将可点击的 SVG 图像插入 Sphinx 文档

    我有 SVG 图像文件 其中有多个节点 每个节点都与 URL 关联 如果我直接在浏览器中打开此文件 我可以单击每个节点 它将打开不同的 URL 但是 当我在 Sphinx 文档中使用这张图片时 它不起作用 图片作为一个整体呈现 所以我需要通

  • 在 sphinx 侧边栏中启用版本阅读文档主题

    我想将 versions html 包含在侧边栏中 但无法成功 我尝试在 中为侧边栏添加 versions html 但这没有效果 html sidebars versions html 另外如何声明不同的版本conf py 我看过sphi

随机推荐

热门标签