Remove spurious diffs in doc build changes #36483
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…es after mathjax CDN change
…in sage_docbuild.conf
…in sage_docbuild.conf (fixup)
…s, make sagemath_doc_html-no-deps
7827a10 to
2c04ca0
Compare
349da52 to
b5b49e2
Compare
9e5dae7 to
228cb67
Compare
0cbd08c to
3013bd5
Compare
|
Thanks. But I found a glitch meanwhile. Let me fix this first :-) |
bc4176e to
c81d50f
Compare
|
Ready to go. Thanks! |
|
needs rebase now |
|
Thanks. Merged with develop cleanly by git. |
|
By the way, is there a reason that changes are only from |
|
Only the English docs are uploaded to netlify, see the end of the "Copy docs" step. |
|
Ah, right. Then this is a bigger problem, to be discussed elsewhere. Thanks. |
|
Documentation preview for this PR (built with commit 67e7f95; changes) is ready! 🎉 |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Oct 21, 2023
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
|
The improved CHANGES display is really nice. |
|
Thanks. It would've been better if diffsite scrolls to (or highlight) diff parts. I found no way to do that automatically (perhaps need AI). But from my experience, the manual method in the description of this PR works well enough. |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Oct 24, 2023
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
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Oct 26, 2023
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
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Oct 28, 2023
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
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Oct 28, 2023
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
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Oct 29, 2023
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
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Noneinstead and apply the default (the function) in the code part.📝 Checklist
⌛ Dependencies