Repository navigation
Use Meson targets to build the manuals - #42646
Conversation
|
Documentation preview for this PR (built with commit 4f30a85; changes) is ready! 🎉 |
|
Thanks for doing this, we are overdue to replace all of this old incorrect documentation, but the review should be left up to someone who actually uses pip or the sage distro. |
I have checked this in conda. maybe someone need to check this in sage-the-distro |
tobiasdiez
left a comment
There was a problem hiding this comment.
Thanks a lot! Ideally it would be just "run sphinx" but until we are there, this is good enough.
Cannot say if it works for the sage-the-distro people....
| $ pip install -Ceditable-verbose=true -Csetup-args="-Dbuild-docs=False" --no-build-isolation --editable . | ||
|
|
||
|
|
||
| .. _section-building-manuals-pip: |
There was a problem hiding this comment.
Not sure if the duplication is worth. I would either replace it by a link to the sage_manuals docs or at least move it down to be just before the "background info".
There was a problem hiding this comment.
Can you check this again? I have checked the sage-the-distro
|
@trevorkarn pointed out on sage-devel that the error at https://github.com/sagemath/sage/blob/develop/src/sage/misc/sagedoc.py#L1633 needs an update too |
aefcca7 to
e745485
Compare
| .. code-block:: console | ||
|
|
||
| $ sage --docbuild tutorial html | ||
| $ meson compile -C builddir doc-html-other-en-tutorial |
There was a problem hiding this comment.
| $ meson compile -C builddir doc-html-other-en-tutorial | |
| $ meson compile -C <builddir> doc-html-other-en-tutorial |
| # documentation), and look at the resulting tex file in | ||
| # SAGE_DOC/latex/en/tutorial. The preamble should contain | ||
| # To see the results of this, run | ||
| # 'meson compile -C builddir doc-pdf-other-en-tutorial', where builddir is |
There was a problem hiding this comment.
| # 'meson compile -C builddir doc-pdf-other-en-tutorial', where builddir is | |
| # `meson compile -C <builddir> doc-pdf-other-en-tutorial`, where `<builddir>` is |
|
I have some additional suggested changes available on https://github.com/trevorkarn/sage/tree/codex/fix-41887-docbuild-docs. @cxzhong, do you have any thoughts on those? The point is to fix the call to |
|
Since the previous instructions are broken, this seems high priority to me to get merged before 10.10 is released. I personally would approve these changes even without any of the suggestions I've added, so that we can get closer to an accurate documentation, even if it is not perfect. |
This updates the documentation build instructions for editable pip installs.
The pip-installed
sagecommand does not expose the legacy--docbuildoption, so installing
pkgs/sage-docbuildseparately does not provide thedocumented workflow.
The documentation now:
doc-htmlanddoc-pdftargets for complete builds;build/cpXYMeson build directory;and
latex_macros.pyguidance consistently; andeditable-install walkthrough.
This lets contributors rebuild documentation without relying on a Sage
command-line option that is unavailable in the editable pip workflow.
Fixes #41887.
Validation
git diff --checkmeson introspectsection label; final PDF compilation was blocked by missing
luaotfload-mainandluatex85.stycomponents in the local TeX Liveinstallation
📝 Checklist
⌛ Dependencies
None.