Ribasim icon indicating copy to clipboard operation
Ribasim copied to clipboard

Include docs PDF in release assets

Open visr opened this issue 2 years ago • 6 comments

Currently we only use the Quarto HTML output which we host online. For offline use it would be good to build and include the PDF output of our documentation.

https://quarto.org/docs/output-formats/pdf-basics.html

  • [ ] get PDF output working, I believe https://github.com/Deltares/iMOD-Documentation already has it
  • [ ] add it to CI for our nightly and release builds
  • [ ] update the release process docs

Having this would alleviate #665, giving users a way to read old documentation.

visr avatar Oct 13 '23 13:10 visr

Sounds like a good idea. We should also check at least from time to time if the pdf is indeed complete and formatted nicely.

Having this would alleviate https://github.com/Deltares/Ribasim/issues/665, giving users a way to read old documentation.

Agreed, a PDF is a nice alternative to hacking in a version selector or adding our own HTML page that links to the different versions (see e.g. GTK4 Rust docs)

Hofer-Julian avatar Oct 16 '23 07:10 Hofer-Julian

I tried adding a quarto-render-pdf task in pixi.toml, which is the same as quarto-render but with --to pdf.

First it complained that no TeX installation was detected, so I ran quarto install tinytex. After that it the amsmath package failed on some equations on allocations.qmd: "Package amsmath Error: Erroneous nesting of equation structures;"

visr avatar Oct 30 '23 20:10 visr

With #735 and #737 we are closer to PDF output. However, there is a bug that is fixed upstream in Quarto for including remote images, that was discussed in #737.

It's easiest to put this on hold until Quarto 1.4 is released, that is already available as a pre-release, but not in conda-forge / pixi.

visr avatar Nov 06 '23 12:11 visr

With the update to Quarto 1.4 in #1139 this is no longer Paused.

visr avatar Feb 16 '24 12:02 visr

~~This is currently blocked by https://github.com/conda-forge/quarto-feedstock/issues/44~~

Hofer-Julian avatar Mar 20 '24 13:03 Hofer-Julian

This is currently blocked by https://github.com/Deltares/Ribasim/pull/1298#issuecomment-2085709572

visr avatar Apr 30 '24 15:04 visr