Skip to content

Improve usetex and pgf troubleshooting docs.#30040

Merged
timhoffm merged 1 commit intomatplotlib:mainfrom
anntzer:td
May 12, 2025
Merged

Improve usetex and pgf troubleshooting docs.#30040
timhoffm merged 1 commit intomatplotlib:mainfrom
anntzer:td

Conversation

@anntzer
Copy link
Copy Markdown
Contributor

@anntzer anntzer commented May 11, 2025

  • Merge "Troubleshooting" and "Possible hangups".
  • Don't list $PATH issues twice.
  • Remove mention of dvipng for pgf (which doesn't use dvipng).
  • Be more generic re: missing latex packages (this applies to all texlive installs, and the required list is given elsewhere).

PR summary

PR checklist

@github-actions github-actions bot added the Documentation: user guide files in galleries/users_explain or doc/users label May 11, 2025
Comment on lines +152 to +153
* Some required LaTeX packages, such as type1cm, may be missing from minimalist
TeXLive installs. Required packages are listed at :ref:`tex-dependencies`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Some required LaTeX packages, such as type1cm, may be missing from minimalist
TeXLive installs. Required packages are listed at :ref:`tex-dependencies`.
* Some required LaTeX packages, such as type1cm, may be missing from minimalist installs. Required packages are listed at :ref:`tex-dependencies`.

I think minimalist any installs? (like the original issue was from someone on a mac)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, edited.

Comment on lines +135 to +136
* Make sure LaTeX, dvipng, and Ghostscript are each working and on your
:envvar:`PATH`. The :envvar:`PATH` environment variable may need to
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you give an example of what this means, particularly for dvipng?

Copy link
Copy Markdown
Contributor Author

@anntzer anntzer May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll claim this text is at least not worse than the previous one, and that a more detailed description of $PATH (probably something like "shutil.which("foo") returns something else than None) should go to environment_variables_faq.rst, but this can be done as a separate PR.

(Also, the dependency on dvipng may be removed soon, see #30039.)

- Merge "Troubleshooting" and "Possible hangups".
- Don't list $PATH issues twice.
- Remove mention of dvipng for pgf (which doesn't use dvipng).
- Be more generic re: missing latex packages (this applies to all
  texlive installs, and the required list is given elsewhere).
@timhoffm timhoffm added this to the v3.11.0 milestone May 12, 2025
@timhoffm
Copy link
Copy Markdown
Member

I believe this is good enough.

@timhoffm timhoffm merged commit 8cd97bf into matplotlib:main May 12, 2025
22 checks passed
@anntzer anntzer deleted the td branch May 12, 2025 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: user guide files in galleries/users_explain or doc/users Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants