Remove ability to conditionalize parts of the documentation #39990
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
This reverts commit 61b9f0e.
|
Documentation preview for this PR (built with commit c687717; changes) is ready! 🎉 |
|
Failing tests seem to be false-alerts. @dimpase could you please have a look at this PR. Thanks! |
dimpase
approved these changes
Apr 23, 2025
|
thanks for taking care of this |
|
The new chinese tour also needs the same treatment, can you add it after the next beta is released? |
Of course, I will follow this work. |
fisheryv
added a commit
to fisheryv/sage
that referenced
this pull request
Apr 30, 2025
…of the documentation from Chinese docs.
5 tasks
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 1, 2025
sagemathgh-39990: Remove ability to conditionalize parts of the documentation The PR sagemath#36495 introduced the ability to disable building parts of the documentation based on some features. This was meant to help the modularization project, but was never actually used. On the other hand, it checks for *every* of the around 200 document the presence of *every* feature, leading to quite a considerable overhead for building the documentation. Thus this feature is reverted for now (until it's actually needed and perhaps can be re-implemented in a better way). <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] 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 and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#39990 Reported by: Tobias Diez Reviewer(s): Dima Pasechnik
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 1, 2025
sagemathgh-40025: Follow the PR sagemath#39990, revert "src/doc/zh/**/conf.py: Fix handling of tags" Follow the PR sagemath#39990, remove ability to conditionalize parts of the documentation from Chinese docs. I have reverted ` src/doc/zh/**/conf.py` as what @tobiasdiez did in commit fc6a150. @vbraun ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] 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 and checked the documentation preview. ### ⌛ Dependencies sagemath#39990 : Remove ability to conditionalize parts of the documentation URL: sagemath#40025 Reported by: Fisher Reviewer(s): Tobias Diez
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 4, 2025
sagemathgh-39990: Remove ability to conditionalize parts of the documentation The PR sagemath#36495 introduced the ability to disable building parts of the documentation based on some features. This was meant to help the modularization project, but was never actually used. On the other hand, it checks for *every* of the around 200 document the presence of *every* feature, leading to quite a considerable overhead for building the documentation. Thus this feature is reverted for now (until it's actually needed and perhaps can be re-implemented in a better way). <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] 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 and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#39990 Reported by: Tobias Diez Reviewer(s): Dima Pasechnik
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 4, 2025
sagemathgh-40025: Follow the PR sagemath#39990, revert "src/doc/zh/**/conf.py: Fix handling of tags" Follow the PR sagemath#39990, remove ability to conditionalize parts of the documentation from Chinese docs. I have reverted ` src/doc/zh/**/conf.py` as what @tobiasdiez did in commit fc6a150. @vbraun ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] 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 and checked the documentation preview. ### ⌛ Dependencies sagemath#39990 : Remove ability to conditionalize parts of the documentation URL: sagemath#40025 Reported by: Fisher Reviewer(s): Tobias Diez
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 5, 2025
sagemathgh-39990: Remove ability to conditionalize parts of the documentation The PR sagemath#36495 introduced the ability to disable building parts of the documentation based on some features. This was meant to help the modularization project, but was never actually used. On the other hand, it checks for *every* of the around 200 document the presence of *every* feature, leading to quite a considerable overhead for building the documentation. Thus this feature is reverted for now (until it's actually needed and perhaps can be re-implemented in a better way). <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] 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 and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#39990 Reported by: Tobias Diez Reviewer(s): Dima Pasechnik
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 5, 2025
sagemathgh-40025: Follow the PR sagemath#39990, revert "src/doc/zh/**/conf.py: Fix handling of tags" Follow the PR sagemath#39990, remove ability to conditionalize parts of the documentation from Chinese docs. I have reverted ` src/doc/zh/**/conf.py` as what @tobiasdiez did in commit fc6a150. @vbraun ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] 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 and checked the documentation preview. ### ⌛ Dependencies sagemath#39990 : Remove ability to conditionalize parts of the documentation URL: sagemath#40025 Reported by: Fisher Reviewer(s): Tobias Diez
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 6, 2025
sagemathgh-39990: Remove ability to conditionalize parts of the documentation The PR sagemath#36495 introduced the ability to disable building parts of the documentation based on some features. This was meant to help the modularization project, but was never actually used. On the other hand, it checks for *every* of the around 200 document the presence of *every* feature, leading to quite a considerable overhead for building the documentation. Thus this feature is reverted for now (until it's actually needed and perhaps can be re-implemented in a better way). <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] 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 and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#39990 Reported by: Tobias Diez Reviewer(s): Dima Pasechnik
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 6, 2025
sagemathgh-40025: Follow the PR sagemath#39990, revert "src/doc/zh/**/conf.py: Fix handling of tags" Follow the PR sagemath#39990, remove ability to conditionalize parts of the documentation from Chinese docs. I have reverted ` src/doc/zh/**/conf.py` as what @tobiasdiez did in commit fc6a150. @vbraun ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] 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 and checked the documentation preview. ### ⌛ Dependencies sagemath#39990 : Remove ability to conditionalize parts of the documentation URL: sagemath#40025 Reported by: Fisher Reviewer(s): Tobias Diez
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 9, 2025
sagemathgh-40025: Follow the PR sagemath#39990, revert "src/doc/zh/**/conf.py: Fix handling of tags" Follow the PR sagemath#39990, remove ability to conditionalize parts of the documentation from Chinese docs. I have reverted ` src/doc/zh/**/conf.py` as what @tobiasdiez did in commit fc6a150. @vbraun ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] 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 and checked the documentation preview. ### ⌛ Dependencies sagemath#39990 : Remove ability to conditionalize parts of the documentation URL: sagemath#40025 Reported by: Fisher Reviewer(s): Tobias Diez
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.
The PR #36495 introduced the ability to disable building parts of the documentation based on some features. This was meant to help the modularization project, but was never actually used.
On the other hand, it checks for every of the around 200 document the presence of every feature, leading to quite a considerable overhead for building the documentation. Thus this feature is reverted for now (until it's actually needed and perhaps can be re-implemented in a better way).
📝 Checklist
⌛ Dependencies