Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the ReadTheDocs build #1083

Closed
jpivarski opened this issue Jan 16, 2024 · 0 comments · Fixed by #1084
Closed

Fix the ReadTheDocs build #1083

jpivarski opened this issue Jan 16, 2024 · 0 comments · Fixed by #1084
Labels
docs Improvements or additions to documentation

Comments

@jpivarski
Copy link
Member

The last successful build was on September 25, 2023. It looks like v5.0.12 was the latest (already existing) git tag at that time.

The very first error after that is:

The configuration key "build.os" is required to build your documentation. Read more at https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os

It looks like we just need to add

build:
  os: ubuntu-22.04

to

version: 2
sphinx:
configuration: docs-sphinx/conf.py
python:
version: 3.7
install:
- requirements: docs-sphinx/requirements.txt
- method: pip
path: .

It's probably very easy! But this failure in documentation-building should have become an alert somehow. I'll look into how to make that happen.

@jpivarski jpivarski added the docs Improvements or additions to documentation label Jan 16, 2024
@jpivarski jpivarski linked a pull request Jan 16, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant