Skip to content

Conversation

@kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Aug 25, 2025

as promised in #40586 (comment)

The added text highlights features of the documentation previews broken as of 10.8.beta2:

  • PDF icons should not appear in the HTML documentation previews for PRs.
  • TESTS blocks should appear in the HTML documentation previews for PRs.
  • "Sage" "Python" "Sage Live" tabs should appear in the full live documentation for releases (perhaps side effects of the "missing sagemath kernel" issue Revive doc-release #40586 (comment)).

📝 Checklist

  • 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

@kwankyu kwankyu mentioned this pull request Aug 25, 2025
5 tasks
@kwankyu kwankyu changed the title Add subsection Documentation Previews Add subsection Documentation Previews to developer guide Aug 25, 2025
@kwankyu kwankyu force-pushed the p/doc-for-doc-previews branch 2 times, most recently from 7a7c16e to 2651203 Compare August 25, 2025 03:37
@kwankyu kwankyu marked this pull request as ready for review August 25, 2025 05:13
@github-actions
Copy link

github-actions bot commented Aug 25, 2025

Documentation preview for this PR (built with commit 1129d51; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@kwankyu kwankyu force-pushed the p/doc-for-doc-previews branch from 075eff0 to 9669abc Compare August 28, 2025 02:12
@kwankyu
Copy link
Collaborator Author

kwankyu commented Sep 12, 2025

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 16, 2025
sagemathgh-40681: Add subsection Documentation Previews to developer guide
    
<!-- ^ 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". -->

as promised in
sagemath#40586 (comment)

The added text highlights features of the documentation previews broken
as of 10.8.beta2:

- PDF icons should not appear in the HTML documentation previews for
PRs.
- TESTS blocks should appear in the HTML documentation previews for PRs.
- "Sage" "Python" "Sage Live" tabs should appear in the full live
documentation for releases (perhaps side effects of the "missing
sagemath kernel" issue
sagemath#40586 (comment)).

### 📝 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

<!-- 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#40681
Reported by: Kwankyu Lee
Reviewer(s):
@vbraun vbraun merged commit 3df6f01 into sagemath:develop Sep 21, 2025
22 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants