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.

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

CI only builds the reference manual on macos #1315

Open
keyboardDrummer opened this issue Jul 19, 2021 · 1 comment
Open

CI only builds the reference manual on macos #1315

keyboardDrummer opened this issue Jul 19, 2021 · 1 comment
Assignees
Labels
part: documentation Dafny's reference manual, tutorial, and other materials priority: not yet Will reconsider working on this when we're looking for work

Comments

@keyboardDrummer
Copy link
Member

See the code

@keyboardDrummer keyboardDrummer added the part: documentation Dafny's reference manual, tutorial, and other materials label Jul 19, 2021
@davidcok davidcok self-assigned this Jul 15, 2022
@davidcok
Copy link
Collaborator

davidcok commented Aug 8, 2022

The RM is written in Github markdown and published through GitHub pages to dafny.org.
Also, a pdf version is produced by using pandoc to convert markdown to Latex and thence to pdf.
The latter is done for each release in a GitHub action for the purpose. The Github action requires setting up an OS and environment and installing the panic and Latex tools. This works for versions of MacOS, but so far attempts to make a working environment on Ubuntu or Windows (even WSL) have failed. The issue is not particularly critical because all the project needs is a build of the pdf that works on some platform.

Slightly more important is that the Makefile (https://github.com/dafny-lang/dafny/blob/master/docs/DafnyRef/Makefile) that generates a between-releases version of the pdf only runs on MacOS. However, we are no longer publishing a bleeding-edge pdf of the RM, so this is only a problem for a developer who wants to check that the Makefile (which is the same as is used during release) produces a valid pdf (with correct formatting etc) but is not developing on MacOS.

At the moment this impediment is not a serious problem and so, while leaving this issue open, it is deemed low priority.

@MikaelMayer MikaelMayer added the priority: not yet Will reconsider working on this when we're looking for work label Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: documentation Dafny's reference manual, tutorial, and other materials priority: not yet Will reconsider working on this when we're looking for work
Projects
None yet
Development

No branches or pull requests

3 participants