[WIP] Add .readthedocs.yaml configuration file

[Copilot]

• Add .readthedocs.yaml configuration file to the repository root
  • Version 2 configuration
  • Ubuntu 22.04 with Python 3.11
  • Sphinx configuration pointing to docs/conf.py
  • PDF and epub formats enabled
  • Python dependencies from docs/requirements.txt
• Verify the configuration file is valid and complete

Original prompt

Problem

Read the Docs builds are failing with the error:

"No default configuration file found at repository's root"

The last successful build was over 2 years ago (commit 7ac3f65). Read the Docs has since changed their policy and now requires a .readthedocs.yaml configuration file at the repository root. Previously, they used implicit defaults, but this is no longer supported.

Solution

Add a .readthedocs.yaml file to the repository root with the following configuration:

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

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.11"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/conf.py

# Optionally, build localized docs for multiple formats
formats:
  - pdf
  - epub

# Optional: Declare Python requirements
python:
  install:
    - requirements: docs/requirements.txt

Notes

• The old build used Python 3.7 which is now deprecated, so upgrading to Python 3.11
• The docs/requirements.txt file already exists in the repository
• The Sphinx configuration is at docs/conf.py
• This will restore documentation builds at imdlib.readthedocs.io

This pull request was created as a result of the following prompt from Copilot chat.

Problem

Read the Docs builds are failing with the error:

"No default configuration file found at repository's root"

The last successful build was over 2 years ago (commit 7ac3f65). Read the Docs has since changed their policy and now requires a .readthedocs.yaml configuration file at the repository root. Previously, they used implicit defaults, but this is no longer supported.

Solution

Add a .readthedocs.yaml file to the repository root with the following configuration:

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

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.11"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/conf.py

# Optionally, build localized docs for multiple formats
formats:
  - pdf
  - epub

# Optional: Declare Python requirements
python:
  install:
    - requirements: docs/requirements.txt

Notes

• The old build used Python 3.7 which is now deprecated, so upgrading to Python 3.11
• The docs/requirements.txt file already exists in the repository
• The Sphinx configuration is at docs/conf.py
• This will restore documentation builds at imdlib.readthedocs.io

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.