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

update ReadTheDocs settings file #2083

Merged
merged 14 commits into from
Jan 24, 2025
Merged

update ReadTheDocs settings file #2083

Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
c1130c5
update RTD config
drammock Dec 18, 2024
d357357
rename file
drammock Dec 18, 2024
813b30e
Update .readthedocs.yaml
drammock Jan 16, 2025
90a5322
Update .readthedocs.yaml
drammock Jan 16, 2025
e11d83b
Revert "Update .readthedocs.yaml"
drammock Jan 16, 2025
9049650
try installing deps with apt
drammock Jan 21, 2025
4396f95
use nitpicky
drammock Jan 21, 2025
55389e4
minor cleanup
drammock Jan 21, 2025
071317b
remove the custom warnings checker
drammock Jan 21, 2025
b3addeb
flesh out nitpicky ignores
drammock Jan 21, 2025
ce874ec
Revert "remove the custom warnings checker"
drammock Jan 21, 2025
e5edd7d
fixed nitpicky
drammock Jan 21, 2025
e24a735
don't fail RTD on warning
drammock Jan 21, 2025
8e6d749
toxfile: build w/ nitpicky; show full traceback on fail
drammock Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions readthedocs.yml → .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
version: 2

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

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

apt_packages:
- graphviz
jobs:
Expand All @@ -16,7 +17,14 @@ build:
- playwright install chromium
drammock marked this conversation as resolved.
Show resolved Hide resolved
- python ./docs/scripts/generate_gallery_images.py

sphinx:
configuration: docs/conf.py
Comment on lines +24 to +25
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.

# 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.


python:
install:
- method: pip
path: .[doc]
path: .
extra_requirements:
- doc
Comment on lines +32 to +34
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]

Loading