Skip to content

Doc: Fixing doc references after click 8.2 release#6880

Merged
agoscinski merged 1 commit into
aiidateam:mainfrom
agoscinski:fix-sphinx-click
May 20, 2025
Merged

Doc: Fixing doc references after click 8.2 release#6880
agoscinski merged 1 commit into
aiidateam:mainfrom
agoscinski:fix-sphinx-click

Conversation

@agoscinski
Copy link
Copy Markdown
Collaborator

click released v8.2.0 and by that broke the references to their doc. click only keeps one version of the documentation so we cannot reference a different API. Thus we reference the functions by the GitHub link for v8.1.0.

`click` released v8.2.0 and by that broke the references to their doc. `click`
only keeps one version of the documentation so we cannot reference a different
API. Thus we reference the functions by the GitHub link for v8.1.0.
@codecov
Copy link
Copy Markdown

codecov Bot commented May 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.59%. Comparing base (b618cb7) to head (f4b0419).
⚠️ Report is 50 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6880      +/-   ##
==========================================
- Coverage   78.59%   78.59%   -0.00%     
==========================================
  Files         567      567              
  Lines       43092    43092              
==========================================
- Hits        33866    33864       -2     
- Misses       9226     9228       +2     

☔ View full report in Codecov by Sentry.
📢 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.

@agoscinski agoscinski requested review from khsrali and unkcpz May 19, 2025 15:39
@unkcpz
Copy link
Copy Markdown
Member

unkcpz commented May 20, 2025

Based on the fact that we pinned the click==8.1, this is a valid change.

@agoscinski agoscinski merged commit 5168032 into aiidateam:main May 20, 2025
11 checks passed
@agoscinski agoscinski deleted the fix-sphinx-click branch May 20, 2025 10:03
@khsrali khsrali linked an issue May 20, 2025 that may be closed by this pull request
@agoscinski
Copy link
Copy Markdown
Collaborator Author

agoscinski commented May 21, 2025

Note that in the commit message I misunderstood the ~=v8.1 pinning. It technically also allows 8.2.0 so we need to pin click to ~=8.1.0. I am not sure why the test-install ci workflow did not error out till 8.2.1.

EDIT: The test-install never ran because it is only triggered when one of the files specifying deps is change. That is why the CI did not fail here.

@agoscinski agoscinski mentioned this pull request May 21, 2025
agoscinski added a commit to agoscinski/aiida-core that referenced this pull request May 22, 2025
`click` released v8.2.0 and by that broke the references to their doc. We pinned
`click~=8.1` so we still need to reference the old API but because `click` only
keeps one version of the documentation, we cannot reference a different API.
Thus we reference the functions by the GitHub link for v8.1.0.

Cherry-pick: 5168032
agoscinski added a commit that referenced this pull request May 22, 2025
`click` released v8.2.0 and by that broke the references to their doc. We pinned
`click~=8.1` so we still need to reference the old API but because `click` only
keeps one version of the documentation, we cannot reference a different API.
Thus we reference the functions by the GitHub link for v8.1.0.

Cherry-pick: 5168032
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Docs: RTD: Two warning on latest, appeared out of nowhere 👻

2 participants