Add version selector to doc #38285
Add version selector to doc #38285
Conversation
kwankyu
force-pushed
the
p/add-version-selector
branch
6 times, most recently
from
6c6dd0c
to
dd02366
Compare
|
Nice! Would the selection box better be placed in the left sidebar? |
|
I'd rather leave it separate from the main doc elements. I like this style: https://docs.djangoproject.com/en/5.0/ |
|
I think "versions" is a meta element. That it has a fixed place in the screen reflects its meta character. |
|
I could publish doc-10-3 and doc-10.2 from the 10.3 and 10.2 sage installs on my system. They include also pdf docs. But 10.1 and 10.0 on my system do not work. I tried to fix them but failed! Where can I get docs (pdfs included) for 10.1 and 10.0? |
|
artifacts in github are gone. |
|
I am building them on ubuntu vm. |
kwankyu
force-pushed
the
p/add-version-selector
branch
from
7ad9f22
to
990ac7d
Compare
|
Looks good to me |
|
I like it too! |
|
Feel free to set to positive review when ready |
|
Thanks. Many thanks for the style suggestion! |
|
PR description still says "This PR is best to be merged after 10.4 release." |
|
That was the plan, but now along with 38332, the versions selector and many fixes are better to be right in 10.4 release. Thanks. |
|
I now learned the reality, how netlify works. 
As the picture shows, old deployments, about 3 months old, are removed from netlify. We need extra resources to sustain versioned docs... |
github-actions
bot
added
s: needs review
v: moderate
and removed
s: positive review
v: large
labels
|
Documentation preview for this PR (built with commit 663dc45; changes) is ready! 🎉 |
…lease
<!-- ^ 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". -->
Announcement banner should appear in sage doc both for beta release and
PRs over beta or stable release.
Currently, as noticed while testing for
sagemath#38285, doc previews for github PRs
over a stable release won't have announcement banner at the top of the
doc. We fix it.
Test:
https://github.com/kwankyu/sage/actions/runs/9770500596/job/26971792855
https://doc-pr-53--sagemath-test.netlify.app/html/en/reference/
Changes is in https://github.com/sagemath/sage/pull/38332/commits/a9decf
4a57a11c723e38ce0dd8cdc28485fac98d, https://github.com/sagemath/sage/pul
l/38332/commits/a51b5715642b0e98fcbbd52fe8882ed75e2d059f
### 📝 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: ... -->
sagemath#38285
URL: sagemath#38332
Reported by: Kwankyu Lee
Reviewer(s):
as #38220 allows us to implement the version selector to sage doc.
Preview : https://doc-pr-53--sagemath-test.netlify.app/html/en/reference/
The script
sage-update-version(used by the release manager) updates src/doc/website/versions.txt. The file will be accessible from https://doc-release--sagemath.netlify.app/html/en/versions.txt, after 10.4 release.The Preview is using https://doc-release--sagemath-test.netlify.app/html/en/versions.txt for test purpose.
📝 Checklist
⌛ Dependencies
#38274