ReadTheDocs 构建不会生成索引文件

Question

虽然没有构建在最近生成重建之前运行良好的文档

Error

Your documentation did not generate an index.html at its root directory. This is required for documentation serving at the root URL for this version.

我使用的 YAML 配置文件相当标准

# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.12"

# Build documentation in the docs/api directory with Sphinx
sphinx:
  builder: html
  configuration: docs/api/conf.py
  # TODO: needs dropping of additional customizations
  fail_on_warning: false

# Build docs in additional formats such as PDF and ePub
formats: all

# Specify dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
  install:
    - requirements: packaging/pip_requirements_minimal.txt
    - method: pip
      path: ./packaging/

有人知道 RTD 想要我吗？

Answer 1

RTD 发布了相关内容：

https://blog.readthedocs.com/builds-without-index/

我将其链接作为错误消息的一部分，这会很好地开始，特别是如果这是一种破坏性行为，并且某些项目可能每年重建一次文档。

话虽这么说，我从项目的 GH README（使用 pandoc 从 MarkDown 转换）中放置了一个 index.rst 并在本地构建了良好的文档，只是远程发出有关 index.rst 的警告，因为他们正在做其他意想不到的事情。

如果 StackOverflow 不是发布此类技术细节的正确位置，我深表歉意，因为他们的支持主要是针对企业的，而他们的“支持论坛”（或他们指向的论坛）就是 StackOverflow。