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.

Sign up for GitHub

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

Jump to bottom

update ReadTheDocs settings file #2083

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

update ReadTheDocs settings file #2083

wants to merge 2 commits into from

Conversation

drammock
Copy link
Collaborator

ReadTheDocs is making some changes that affect us. Will leave self-review to explain the changes.

drammock
drammock commented Dec 18, 2024
View reviewed changes
Copy link
Collaborator Author

@drammock drammock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note also the filename changed from readthedocs.yml to .readthedocs.yaml, as the RTD interface says that this is the only allowed filename (?! makes me wonder if our existing settings file is even being read?)

.readthedocs.yaml
formats:
- htmlzip

# build with latest available ubuntu version
build:
os: ubuntu-20.04
os: ubuntu-lts-latest
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this just seems like common sense

.readthedocs.yaml
tools:
python: "3.10"
python: "3.12"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto, no reason to build on an old Py version

.readthedocs.yaml
Comment on lines +20 to +21
sphinx:
configuration: docs/conf.py
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this bit is now required, and our builds will start failing in January without it.

.readthedocs.yaml
Comment on lines +28 to +30
path: .
extra_requirements:
- doc
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the recommended way to do what we were doing before with path: .[doc]

.readthedocs.yaml
sphinx:
configuration: docs/conf.py
# builder: "dirhtml"
fail_on_warning: true
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is good practice but will probably not work for us, given the long list of "expected" warnings that our build produces. 🤔 maybe we should revisit how we handle that, e.g., using a nitpick_ignore in conf.py instead of writing warnings to file and using a post-build script to check them against our "expected warnings" lists. Let's see what happens.

@github-actions GitHub Actions
Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

@drammock
Copy link
Collaborator Author

hmm, hitting

║ Host system is missing dependencies to run browsers. ║
║ Please install them with the following command:      ║
║                                                      ║
║     sudo playwright install-deps

which wasn't happening before, e.g. on recent build https://readthedocs.org/projects/pydata-sphinx-theme/builds/26618254/

I wonder if it's due to the Ubuntu version bump? Will investigate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@drammock