Skip to content

added .reathedocs.yaml

Kefei Mo requested to merge hot-fix/adding-yaml-config into main

Overview

Readthedocs website requires the repo have .readthedocs.yaml config file, otherwise the build will fail. (Monday, September 25, 2023: Fully remove support for building documentation without configuration file v2.) ref: https://blog.readthedocs.com/migrate-configuration-v2/

Solution

Modified the minimal config file example in https://blog.readthedocs.com/migrate-configuration-v2/, and verified with a dummy website.

How I verified

Discussion

It is also recommended to have requirements.txt file. The dependencies being tested are

  • Python = 3.10.6
  • Sphinx = 7.2.2
Edited by Kefei Mo

Merge request reports