Migrate pdf-doc build to meson #40597
Conversation
|
Documentation preview for this PR (built with commit 62a9bfd; changes) is ready! 🎉 |
|
this still doesn't reenable live doc, no? remark: it doesn't speed up the build (understandable, since most of the time are spent on running lualatex) |
I didn't touch the live docs here, and leave this to #40586.
There could be some speed gains if we convince sphinx to export a dep file (maybe similar to https://gitlab.com/qemu-project/qemu/-/blob/master/docs/sphinx/depfile.py?ref_type=heads) so that meson can watch the source files for each doc target and then incrementally rebuild the docs. That should be faster than sphinx' incrementally rebuild logic. |
|
that may not be necessary, the bottleneck is still in latexmk. TeX's dependency tracker is quite fickle, I don't think we will ever be able to make a meson replacement for latexmk. But either way, likely out of scope here. (latexmk's incremental tracking is not 100% correct either, but better than nothing.) |
|
Right, the idea with depfile was also more for the html build. Honestly, I don't care about the pdf. I think the website is fully sufficient and only a handful of people are actually looking at those pdfs. The only real purpose is to catch latex errors... |
sagemathgh-40597: Migrate pdf-doc build to meson <!-- ^ 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". --> Migrate the pdf-doc building to meson. For this, a bug in the builder is fixed that prevented running Make against the sphinx-generated files when invoked via meson. Along the way, the output in case of an error of the make script is improved. Generated pdfs can be found at https://github.com/sagemath/sage/actions/ runs/17005745386/artifacts/3779209846. ### 📝 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#40597 Reported by: Tobias Diez Reviewer(s):
<!-- ^ 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". --> Migrate the pdf-doc building to meson. For this, a bug in the builder is fixed that prevented running Make against the sphinx-generated files when invoked via meson. Along the way, the output in case of an error of the make script is improved. Generated pdfs can be found at https://github.com/sagemath/sage/actions/ runs/17005745386/artifacts/3779209846. ### 📝 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#40597 Reported by: Tobias Diez Reviewer(s):
<!-- ^ 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". --> Migrate the pdf-doc building to meson. For this, a bug in the builder is fixed that prevented running Make against the sphinx-generated files when invoked via meson. Along the way, the output in case of an error of the make script is improved. Generated pdfs can be found at https://github.com/sagemath/sage/actions/ runs/17005745386/artifacts/3779209846. ### 📝 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#40597 Reported by: Tobias Diez Reviewer(s):
|
maybe you should merge latest develop first (PDF build only starts failing there). |
Migrate the pdf-doc building to meson. For this, a bug in the builder is fixed that prevented running Make against the sphinx-generated files when invoked via meson. Along the way, the output in case of an error of the make script is improved.
Generated pdfs can be found at https://github.com/sagemath/sage/actions/runs/17005745386/artifacts/3779209846.
📝 Checklist
⌛ Dependencies