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.

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

[Doc]: make html fail early if latex not present #24648

Closed
jamesbraza opened this issue Dec 6, 2022 · 1 comment · Fixed by #27649
Closed

[Doc]: make html fail early if latex not present #24648

jamesbraza opened this issue Dec 6, 2022 · 1 comment · Fixed by #27649
Milestone

Comments

@jamesbraza
Copy link
Contributor

Documentation Link

https://matplotlib.org/devdocs/devel/documenting_mpl.html#building-the-docs

Problem

If you don't have LaTeX installed, make html will fail about 5-mins in. I then came upon this (from here):

Required:

  • a minimal working LaTeX distribution

I think it would be a nice feature to deny make html without a LaTeX being present.

Suggested improvement

Have the doc/Makefile's make html recipe have a "guard" mechanism that, if LaTeX isn't installed, errors with:

LaTeX is required for this command.

This could also be a good sister solution to #24646, where the guard behavior checks the LaTeX installation works and has the required packages installed.

@story645
Copy link
Member

story645 commented Dec 6, 2022

part of implementing this would be adding the sort of checks that #24414 would require and I also think this would be good as a standalone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants