.github/workflows/doc-build-pdf.yml: Do not build HTML documentation, fix upload of PDFs #36614
Conversation
This file contains 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
|
Where can I see the built pdf docs? |
|
The upload step was being skipped. Fixed now, it should be available as an artifact. |
|
(I've cherry-picked this last commit from #36508.) |
mkoeppe
changed the title
|
On the other hand, it would be nice to publish the built pdf doc to the same place where html doc is published so that html and pdf docs are available together in the doc preview. pdf docs may be published later after html docs so that developers can examine html docs first. But I am not sure if Tobias' netlify account allows that much space... |
|
I agree that it would be nice, but I have no experience with the netlify upload, so if at all possible, it will have to be done in a separate PR. |
|
Yes, of course. |
|
merge conflict |
Space is not the issue, but I don't think its possible to only add the pdf later (so you would need to download the build artifact from the html build, add the pdf, then upload everything). |
|
Documentation preview for this PR (built with commit c4ac3f4; changes) is ready! 🎉 |
It may not be worth while for PRs. But for pushes to develop, it may be worth another workflow. After #36601, the netlify site will have this html/(en/...) By the new workflow (perhaps doc-publish-pdf), it would be html/(en/...) The two workflows should publish to the same url, of course. |
|
I suspect that the change of this PR -make doc-clean doc-uninstall; make doc-pdf
+make doc-clean doc-uninstall; make sagemath_doc_html-build-deps sagemath_doc_pdf-no-depstriggered failures like https://github.com/sagemath/sage/actions/runs/6811957358/job/18523428561?pr=36592 From the log, |
5 tasks
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Nov 12, 2023
sagemathgh-36692: Make doc-pdf separate from doc-html <!-- ^^^^^ 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 --> (1) Fixes the issue in sagemath#36614 (comment) by making doc-pdf target separate from doc-html target. (2) Support `.. ONLY::` (introduced by sagemath#36495) in generating rst files for sage modules by the reference builder. (3) Edited the pdf docs website to look consistent and tidy. <!-- 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. - [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: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36692 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Nov 14, 2023
sagemathgh-36692: Make doc-pdf separate from doc-html <!-- ^^^^^ 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 --> (1) Fixes the issue in sagemath#36614 (comment) by making doc-pdf target separate from doc-html target. (2) Support `.. ONLY::` (introduced by sagemath#36495) in generating rst files for sage modules by the reference builder. (3) Edited the pdf docs website to look consistent and tidy. <!-- 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. - [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: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36692 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Nov 16, 2023
sagemathgh-36617: CI: Make jobs more responsive to canceling ... by replacing `always()` by `success() || failure()`, except for steps such as uploading / printing out logs or similar artifacts that have already been built. Even upon canceling a workflow (manually or automatically when a new commit has been pushed to the same branch), a new step that uses `if: always() ....` will still be started, which can clog the GH Actions pipeline. <!-- ^^^^^ 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: ... --> - Depends on sagemath#36614 (merged here to remove merge conflict) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36617 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
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.
Our
maketargetdoc-pdfdepends ondoc-htmlonly to avoid concurrency bugs when updating the inventory files.To speed up the Build Documentation (PDF) workflow, we skip the HTML build.
📝 Checklist
⌛ Dependencies