Migrate CI build-doc to Meson #39973
Conversation
|
Looks like some file permission goes wrong? (symbolic link get converted to normal file?) |
| docs = [doc[1] for doc in sorted(documents)] | ||
| # Put the bibliography first, because it needs to be built first: | ||
| docs.remove(Path('reference/references')) | ||
| docs.insert(0, Path('reference/references')) |
There was a problem hiding this comment.
Why is such a large change necessary in this file?
There was a problem hiding this comment.
To be honest, I got carried a way a bit: the strictly necessary change is to remove mentions of import sage, then I used the chance to use pathlib, and to catch all those paths vs strings issues added typing info. Oh, and there were a few old deprecated stuff in there which was easier to remove than to migrate to pathlib 🦊
|
Documentation preview for this PR (built with commit 3408887; changes) is ready! 🎉 |
|
Doc build is working now, and the changes relative to the last develop build seem to be minimal and mostly due to using a newer sphinx version now. Marking it as blocker since currently the docbuild CI for other PRs is completely failing. |
|
https://github.com/sagemath/sage/actions/runs/15081532937/job/42398821050#step:9:1 fails while building docs the old way - is it normal? |
|
It fails with
https://github.com/sagemath/sage/actions/runs/15081532937/job/42398821050#step:9:3982 so this is the same problem as for the other PRs. |
|
no, my question was - why does that CI run build docs the old way? |
It seems its not published to pypi (tracked at sagemath/sagemath-giac#3) I've now updated primecountpy manually. |
|
OK, thanks for the update, now I am finally able to run |
|
getting an error related to also, can you tell me how to rebuild a part of sagelib, namely, so it seems that the Cython/gcc compilation result for pbory.pyx is cached somewhere, so it has to be purged, but how? |
|
while it's OK for conda, for |
hmm, maybe I should have run |
|
and there are for instance
|
|
As far as I understand, doc-pdf isn't there yet. OK, good. Next PR then. |
|
Build and test (fedora:{41,42}) is failing, what's going on? |
|
a typo in the script: |
|
Thanks for the review @dimpase. I've created new issues for the problems you mentioned. @user202729 This is fixed in #40071 |
sagemathgh-39973: Migrate CI build-doc 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". --> Make it possible to build the documentation with meson via ``` meson compile -C builddir doc-html ``` For this a couple of changes was necessary in the docbuilder: - Make `sage_docbuild` independent of `sage` so that meson can use `sage_docbuild` during config time to construct all the docbuild targets (otherwise one needs to first install sage, and then could configure the docbuild) - Properly handle input and output dirs for the docbuild, without relying on magic sage env variables ### 📝 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#39973 Reported by: Tobias Diez Reviewer(s): Dima Pasechnik, Tobias Diez, user202729
|
I can't figure out how to build the documentation now. I used to do which no longer works since the then I get errors such as since sage hasn't been compiled. Even if I compile it with I get the same error, since the compiled modules aren't available in the python path. The closest I get is if I delete the sage source dir and replace it with a symlink to the installed sage python module, but then I get cryptic errors such as So how do I do it? |
Make it possible to build the documentation with meson via
For this a couple of changes was necessary in the docbuilder:
sage_docbuildindependent ofsageso that meson can usesage_docbuildduring config time to construct all the docbuild targets (otherwise one needs to first install sage, and then could configure the docbuild)📝 Checklist
⌛ Dependencies