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.

Sign up for GitHub

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

Jump to bottom

Include docs PDF in release assets #666

Open
3 tasks
visr opened this issue Oct 13, 2023 · 6 comments · May be fixed by #1298
Open
3 tasks

Include docs PDF in release assets #666

visr opened this issue Oct 13, 2023 · 6 comments · May be fixed by #1298
Labels
CI/CD Continuous Integration/Continuous deployment documentation Improvements or additions to documentation enhancement New feature or request

Comments

@visr
Copy link
Member

visr commented Oct 13, 2023

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

Having this would alleviate #665, giving users a way to read old documentation.
@visr visr added documentation Improvements or additions to documentation CI/CD Continuous Integration/Continuous deployment labels Oct 13, 2023
This was referenced Oct 13, 2023
Merged
Closed
@visr visr added the enhancement New feature or request label Oct 13, 2023
@Hofer-Julian
Copy link
Contributor

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 #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)

evetion pushed a commit that referenced this issue Oct 16, 2023
@visr
add release process to the docs (#668)
cb89d3f 
Fixes #499

The process is not yet optimal, but this describes the current
situation.

I opened #666, #667 and #669 with some ideas for improvements.
@visr
Copy link
Member Author

visr commented Oct 30, 2023

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
Copy link
Member Author

visr commented Nov 6, 2023

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
Copy link
Member Author

visr commented Feb 16, 2024

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

@visr visr changed the title include docs PDF in release assets Include docs PDF in release assets Feb 16, 2024
@Hofer-Julian
Copy link
Contributor

Hofer-Julian commented Mar 20, 2024 •
edited by visr

This is currently blocked by conda-forge/quarto-feedstock#44

@Hofer-Julian Hofer-Julian linked a pull request Mar 20, 2024 that will close this issue
Draft
@visr visr mentioned this issue Apr 29, 2024
Closed
@visr
Copy link
Member Author

visr commented Apr 30, 2024

This is currently blocked by #1298 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CI/CD Continuous Integration/Continuous deployment documentation Improvements or additions to documentation enhancement New feature or request
Projects
Ribasim
Status: What's next
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Render PDF docs Deltares/Ribasim
2 participants
@visr @Hofer-Julian