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

Generate PDFs on CI #274

Merged
merged 36 commits into from
Mar 20, 2024
Merged

Generate PDFs on CI #274

merged 36 commits into from
Mar 20, 2024

Conversation

firthm01
Copy link
Contributor

@firthm01 firthm01 commented Mar 18, 2024

Generates the package documents on the CI rather than having to be a manual step done locally. Note that manual generation hasn't been messed with so is still an option.

Uses cmake to generate README.md from README.in.md, then uses an existing github action to generate PDFs from both the LICENSE.md and README.md files. This also seems to create nicer looking docs by default than the existing pandoc process, Note this action only runs on linux so it's run as a common job for all platform-specific builds before those build jobs are fired off.

History is messy so needs squashing before merging.

@firthm01 firthm01 changed the base branch from main to translocation-fix March 18, 2024 12:58
@firthm01 firthm01 requested a review from rsjbailey March 18, 2024 15:06
@firthm01 firthm01 marked this pull request as ready for review March 18, 2024 17:22
@rsjbailey
Copy link
Contributor

Like you said, would be good to squash the changes to a single commit, but otherwise looks great & much easier than running things manually.

Base automatically changed from translocation-fix to main March 20, 2024 12:51
@firthm01 firthm01 merged commit ed94497 into main Mar 20, 2024
7 checks passed
@firthm01 firthm01 deleted the ci-pdf-gen branch March 20, 2024 12:52
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.

2 participants