-
Notifications
You must be signed in to change notification settings - Fork 12
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 CLI docs action #730
Fix CLI docs action #730
Conversation
My mind is already giving up, but I have been testing in branch ghp-test and I found out the issue is within the action matthiaszepper/sphinx-action-v4 It uses by default python 3.13 which has compatibility issues with this cffi module. I have been trying workarounds but to no avail sadly. The other issue with python 3.13 is that this module was removed Which is need for sphinx to make the documents. And, don't expect Sphinx to add support for python 3.13 until 2026 xd EDIT: After inspecting more deeply (yapping incoming) This action is a forked for another one, that this creator suggested was abandonded (whereas the original one allows specifying a version and does not default to latests) and it's now, surprise, abandoned I believe it will be MUCH better to just have extra steps and generate the document ourselves instead of relying on libraries maintained by random people... |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev #730 +/- ##
==========================================
+ Coverage 47.76% 47.88% +0.12%
==========================================
Files 31 31
Lines 2889 2890 +1
==========================================
+ Hits 1380 1384 +4
+ Misses 1509 1506 -3 ☔ View full report in Codecov by Sentry. |
@ScilifelabDataCentre/teamhermes When there's an approval of this you can merge. |
Signed-off-by: Ina Odén Österbo <[email protected]>
Read this before submitting the PR
If there is a field which you are unsure about, enter the edit mode of this description or go to the PR template; There are invisible comments providing descriptions which may be of help.
1. Description / Summary
This PR fixes the issue with the action publishing the CLI docs to GitHub Pages.
The issue is due to Python 3.13 having removed some packages, which is why I have included the legacy versions of them in the
requirements-dev.txt
.@rv0lt Also fixed the deployment of the docs by bumping some of the
sphinx
packages but that also meant that the majority of the docs were not visible and there were no links to the different commands.This is in no way the best option, but this fixes it. We should however, as discussed, change this entire process to use some action that is well maintained, or create our own action which we would have full permissions on and could fix when issues arise.
2. Jira task / GitHub issue
Link to the github issue or add the Jira task ID here.
3. Type of change
What type of change(s) does the PR contain?
Check the relevant boxes below. For an explanation of the different sections, enter edit mode of this PR description template.
4. Additional information
master
branch: If checked, read the release instructions5. Actions / Scans
Check the boxes when the specified checks have passed.
For information on what the different checks do and how to fix it if they're failing, enter edit mode of this description or go to the PR template.