Skip to content

fix(docs): repair the Read the Docs build configuration - #463

Merged
kentbull merged 1 commit into
WebOfTrust:mainfrom
jaelliot:fix/rtd-keria-config
Sep 11, 2026
Merged

fix(docs): repair the Read the Docs build configuration#463
kentbull merged 1 commit into
WebOfTrust:mainfrom
jaelliot:fix/rtd-keria-config

Conversation

@jaelliot

Copy link
Copy Markdown
Contributor

Repairs the Read the Docs build configuration, which cannot currently succeed.

Previous failure (build 30645134):

ERROR: Could not open requirements file: [Errno 2] No such file or directory: 'requirements.txt'

Root cause - four independent defects in .readthedocs.yaml:

  1. python.install lists requirements: requirements.txt, but no root requirements.txt exists in the repository, so the build aborts during requirements install.
  2. build.os: ubuntu-20.04 is a retired Read the Docs image.
  3. The docs Python was pinned to 3.10, below the project declared requires-python of >=3.12.2.
  4. Nothing installs the package, but docs/conf.py imports keria, and the module init imports hio, so the build fails on import.

What changed:

  • drop the reference to the nonexistent root requirements file
  • install the package itself (method: pip, path: .) so docs/conf.py can import keria
  • move to ubuntu-24.04 and Python 3.14, matching the images already building successfully for the other KERI documentation projects

Validation performed on this branch:

  • YAML parses and resolves to the intended values
  • every referenced path exists: docs/conf.py and docs/requirements.txt
  • config-only change with no application code touched; diff is .readthedocs.yaml, +5/-4
  • dependency resolution checked: PyPI keri 1.3.6 declares a Python requirement of >=3.12.2 and does not carry the pin that currently affects keripy

The Read the Docs preview build is the verifying step for this change.

- Drop the reference to the root requirements.txt, which does not exist
  in the repository and aborts the build during requirements install
- Install the package itself so docs/conf.py can import keria, whose
  module init needs hio at import time
- Move off the retired ubuntu-20.04 image to ubuntu-24.04, matching the
  images already building successfully for the other KERI docs projects
- Raise the docs Python from 3.10 to 3.14; the project declares
  requires-python >= 3.12.2
@jaelliot
jaelliot requested a review from kentbull September 11, 2026 22:33
@codecov

codecov Bot commented Sep 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.24%. Comparing base (53a0686) to head (532592c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #463   +/-   ##
=======================================
  Coverage   88.24%   88.24%           
=======================================
  Files          26       26           
  Lines        5947     5947           
=======================================
  Hits         5248     5248           
  Misses        699      699           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@kentbull
kentbull merged commit 7e685ed into WebOfTrust:main Sep 11, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants