NRLMMD-GEOIPS / geoips

Main Geolocated Information Processing System code base with basic functionality enabled.
https://nrlmmd-geoips.github.io/geoips/
Other
13 stars 10 forks source link

466 latex not listed as a dependency for building docs in installation instructions #536

Closed biosafetylvl5 closed 1 month ago

biosafetylvl5 commented 1 month ago

Related Issues

Related to closed issue: https://github.com/NRLMMD-GEOIPS/geoips/issues/466#issuecomment-2033002503

Testing Instructions

Build docs without latex installed (the default Dockerfile works great)

Summary

I added a more helpful error message that informs the user that "html_only" is an option when building if they attempt to build with the default options and don't have pdflatex installed.

Output

ERROR: latex must be installed in order to create pdf documentation.
  try 'module load latex' if in anaconda
  or re-run with html_only to only build
  html documentation.
biosafetylvl5 commented 1 month ago

This needs to be added to the most recent release note, as this is an old fix that I forgot I did. When y'all say it looks good I can move it over and then merge it.