Skip to content

Script to build spec pdfs#12

Draft
joseph-mueller wants to merge 5 commits intomainfrom
BuildPDF
Draft

Script to build spec pdfs#12
joseph-mueller wants to merge 5 commits intomainfrom
BuildPDF

Conversation

@joseph-mueller
Copy link
Copy Markdown
Member

The script has in-line documentation. Generates reasonable pdf output with proper links back to github.

For now, presume the script will be used manually, could be incorporated into actions and automated.

@joseph-mueller joseph-mueller marked this pull request as draft February 13, 2025 16:30
@joseph-mueller
Copy link
Copy Markdown
Member Author

Ultimately, although the content basically works, was unable to get the generated PDF to have the tidy appearance. Things like choosing a good font, getting internal links and external links colored properly etc.

Difficulty seems to be in the capability of the pandoc containers available. Did not want to require the person generating PDF have a full pandoc and LaTex installation, so recommendation is to generate PDF using tools integrated in VS Code for now.

@alejandro5042
Copy link
Copy Markdown
Contributor

Difficulty seems to be in the capability of the pandoc containers available. Did not want to require the person generating PDF have a full pandoc and LaTex installation, so recommendation is to generate PDF using tools integrated in VS Code for now.

By containers, do you mean Docker containers?

If we were to run the script inside a Docker container with a full install of pandoc/Latex, would that resolve the issue and generate great looking specs?

Is the issue just requiring the user to have a container installed?

(Note: Running containers is a pretty typical SW workflow these days, so I think it would be easy to document.)

@joseph-mueller
Copy link
Copy Markdown
Member Author

joseph-mueller commented Feb 27, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants