-
-
Notifications
You must be signed in to change notification settings - Fork 655
.github/workflows/doc-build.yml: Repair display of changes #36475
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
Conversation
As you pointed out, this is due to the change of using mathjax cdns from 10.2.beta1 and, as I understand it, should have been transient hiccups if ci didn't fail to build images of 10.2.beta2~5 (is this also because of the change?). Now that the images of 10.2.beta6 and beta7 are available, the problem will disappear. Then do we need this fix that looks like bandage? |
The change (in #36160) was done by setting an environment variable in the doc-build workflow. The Docker images however are built with the default configuration, without this environment variable set. (I don't know if/why that should be changed.) |
I see. This is a tricky situation. How about comparing the built doc with the previous doc which was built in the previous run of the build doc workflow on the push to develop branch and stored somewhere? |
The current approach is easy and quick but prone to be broken again someday (when we upgrade mathjax). |
Sure, another possible solution, but I don't think it would be more robust |
…in sage_docbuild.conf
…in sage_docbuild.conf (fixup)
…s, make sagemath_doc_html-no-deps
Documentation preview for this PR (built with commit 76c8549; changes) is ready! 🎉 |
OK, here's a better version that avoids duplicating that specific CDN URL. I've also made the change discussed in #36473 (comment), which gives a cleaner log |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
I am preparing a PR building on this.
Thank you! |
sagemathgh-36475: .github/workflows/doc-build.yml: Repair display of changes <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> From sagemath#36473 (comment) <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - Depends on sagemath#36473 (merged here) - Depends on sagemath#36442 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36475 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-36483: Remove spurious diffs in doc build changes Remove all spurious and chronic diffs in the changes of our documentation preview. Improve CHANGES.html using diffsite. See https://deploy-preview-36483-- sagemath-tobias.netlify.app/changes diffsite allows to compare changes visually. Scroll until vertical alignment breaks or search for some diff text. <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36475 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36483 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
sagemathgh-36475: .github/workflows/doc-build.yml: Repair display of changes <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> From sagemath#36473 (comment) <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - Depends on sagemath#36473 (merged here) - Depends on sagemath#36442 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36475 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-36483: Remove spurious diffs in doc build changes Remove all spurious and chronic diffs in the changes of our documentation preview. Improve CHANGES.html using diffsite. See https://deploy-preview-36483-- sagemath-tobias.netlify.app/changes diffsite allows to compare changes visually. *Scroll until vertical alignment breaks or search for some diff text.* In this regard, refrain from using a function as the default value of an argument in Python definitions. Use `None` instead and apply the default (the function) in the code part. <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36475 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36483 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
sagemathgh-36475: .github/workflows/doc-build.yml: Repair display of changes <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> From sagemath#36473 (comment) <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - Depends on sagemath#36473 (merged here) - Depends on sagemath#36442 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36475 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-36483: Remove spurious diffs in doc build changes Remove all spurious and chronic diffs in the changes of our documentation preview. Improve CHANGES.html using diffsite. See https://deploy-preview-36483-- sagemath-tobias.netlify.app/changes diffsite allows to compare changes visually. *Scroll until vertical alignment breaks or search for some diff text.* In this regard, refrain from using a function as the default value of an argument in Python definitions. Use `None` instead and apply the default (the function) in the code part. <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36475 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36483 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
sagemathgh-36475: .github/workflows/doc-build.yml: Repair display of changes <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> From sagemath#36473 (comment) <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - Depends on sagemath#36473 (merged here) - Depends on sagemath#36442 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36475 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-36483: Remove spurious diffs in doc build changes Remove all spurious and chronic diffs in the changes of our documentation preview. Improve CHANGES.html using diffsite. See https://deploy-preview-36483-- sagemath-tobias.netlify.app/changes diffsite allows to compare changes visually. *Scroll until vertical alignment breaks or search for some diff text.* In this regard, refrain from using a function as the default value of an argument in Python definitions. Use `None` instead and apply the default (the function) in the code part. <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36475 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36483 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
sagemathgh-36475: .github/workflows/doc-build.yml: Repair display of changes <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> From sagemath#36473 (comment) <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - Depends on sagemath#36473 (merged here) - Depends on sagemath#36442 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36475 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-36483: Remove spurious diffs in doc build changes Remove all spurious and chronic diffs in the changes of our documentation preview. Improve CHANGES.html using diffsite. See https://deploy-preview-36483-- sagemath-tobias.netlify.app/changes diffsite allows to compare changes visually. *Scroll until vertical alignment breaks or search for some diff text.* In this regard, refrain from using a function as the default value of an argument in Python definitions. Use `None` instead and apply the default (the function) in the code part. <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36475 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36483 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
sagemathgh-36475: .github/workflows/doc-build.yml: Repair display of changes <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> From sagemath#36473 (comment) <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - Depends on sagemath#36473 (merged here) - Depends on sagemath#36442 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36475 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-36483: Remove spurious diffs in doc build changes Remove all spurious and chronic diffs in the changes of our documentation preview. Improve CHANGES.html using diffsite. See https://deploy-preview-36483-- sagemath-tobias.netlify.app/changes diffsite allows to compare changes visually. *Scroll until vertical alignment breaks or search for some diff text.* In this regard, refrain from using a function as the default value of an argument in Python definitions. Use `None` instead and apply the default (the function) in the code part. <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36475 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36483 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
sagemathgh-36483: Remove spurious diffs in doc build changes Remove all spurious and chronic diffs in the changes of our documentation preview. Improve CHANGES.html using diffsite. See https://deploy-preview-36483-- sagemath-tobias.netlify.app/changes diffsite allows to compare changes visually. *Scroll until vertical alignment breaks or search for some diff text.* In this regard, refrain from using a function as the default value of an argument in Python definitions. Use `None` instead and apply the default (the function) in the code part. <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36475 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36483 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
From #36473 (comment)
📝 Checklist
⌛ Dependencies
build*.yml
through a new script.ci/retrofit-worktree.sh
#36442 (merged here)