Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Installation manual: In all-conda install, explain how to docbuild #35528

Closed
mkoeppe opened this issue Apr 16, 2023 · 3 comments · Fixed by #35604
Closed

Installation manual: In all-conda install, explain how to docbuild #35528

mkoeppe opened this issue Apr 16, 2023 · 3 comments · Fixed by #35604
Labels
c: documentation
Milestone
sage-10.1

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented Apr 16, 2023 •
edited
Loading

In this mode, make is not used, so there will be no initial build of the documentation as part of make all.

https://doc.sagemath.org/html/en/developer/sage_manuals.html does not explain how to run a full build of the documentation.
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 19, 2023

An issue - the documentation of pplpy cannot be installed using conda or pip.
Workaround:

@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 2, 2023 •
edited
Loading

A second issue – Sphinx does not seem to install copies of mathjax in the _static directories.

Confirmed workaround (thanks @xuluze) export SAGE_USE_CDNS=yes.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 3, 2023 •
edited
Loading

Currently, we do not install mathjax in conda at all, so without SAGE_USE_CDNS=yes it's broken.
We should probably do some of the following:

vbraun pushed a commit that referenced this issue May 22, 2023
gh-35536: src/sage_docbuild/conf.py: Do not fail if pplpy doc is not …
5a2cbb7 
…installed

    
<!-- Please provide a concise, informative and self-explanatory title.
-->
<!-- Don't put issue numbers in the title. Put it in the Description
below. -->
<!-- For example, instead of "Fixes #12345", use "Add a new method to
multiply two integers" -->

### 📚 Description

<!-- Describe your changes here in detail. -->
We change the sphinx configuration so that the object inventory of pplpy
is only used when it is installed.

<!-- Why is this change required? What problem does it solve? -->
We currently have no way to install the pplpy documentation when using
the all-conda installation method (#35528).

<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes #12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[x
]`. -->

- [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
- #12345: short description why this is a dependency
- #34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: #35536
Reported by: Matthias Köppe
Reviewer(s): Isuru Fernando, John H. Palmieri, Matthias Köppe
@vbraun vbraun closed this as completed in 6d408e6 Jul 1, 2023
@mkoeppe mkoeppe added this to the sage-10.1 milestone Jul 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: documentation
Projects
None yet
Milestone
sage-10.1
1 participant
@mkoeppe