fab icon indicating copy to clipboard operation
fab copied to clipboard

Latexpdf build broken - missing dependency

Open hiker opened this issue 3 months ago • 2 comments

It looks like librsvg2-bin must be installed in order to create the latex pdf files. I did a pip install --user -e .[docs], but that didn't install all dependencies (sphinxcontrib-svg2pdfconverter got installed). Maybe this can't be automated, but at least it needs to be documented somewhere. On Ubuntu I needed to do sudo apt-get install librsvg2-bin

hiker avatar Sep 09 '25 06:09 hiker

Yes, user will need at least the following lib/packages on their OS to build latexpdf.

librsvg2-bin
texlive-latex-base
texlive-latex-recommended
texlive-fonts-recommended
texlive-latex-extra
latexmk

All OS-level dependencies were correctly included in #470 so the automatic deployment via GitHub Action is functional. (See section under https://github.com/MetOffice/fab/blob/main/.github/workflows/documentation.yml#L39)

Agree, it will help users if we had documented this - the whole Fab documentation is out-of-date and requires a complete major rewrite imo.

yaswant avatar Sep 09 '25 09:09 yaswant

Yes, I looked at the workflow to find out what I needed. While I totally agree that the documentation needs to be re-worked, nothing should be merged in that isn't documented (at least rudimentary). We have no way of keeping track of what needs to be added to the documentation if we keep on not documenting our work. If it's documented, even rudimentary and not in the ideal place, it at least means when we refactor the documentation, we have all the puzzle pieces. This way, things will just be forgotten. Now admittedly, I could have done a better review, but I stated that I don't really understand the workflows, so I didn't check if there was a dependency added there (and I only tested using html target, which works ... silly me :) )

hiker avatar Sep 10 '25 00:09 hiker