Skip to content

Add: GitHub actions support for translated documentation.#81

Open
yestalgia wants to merge 18 commits intomcallegari:mainfrom
yestalgia:qpnxqh-codex/add-github-actions-pdf-builds-for-ca-and-de
Open

Add: GitHub actions support for translated documentation.#81
yestalgia wants to merge 18 commits intomcallegari:mainfrom
yestalgia:qpnxqh-codex/add-github-actions-pdf-builds-for-ca-and-de

Conversation

@yestalgia
Copy link
Collaborator

@yestalgia yestalgia commented Jul 13, 2025

This pull request allows our documentation translations to be transformed into individual PDFs.

I now call the build-pdf action from main.yml and release.yaml in a matrix where it is passed each language code.

New functionality:

  • Auto-detect available languages for PDF build matrix
  • Run PDF builds for each detected language in both main and release workflows

What was required:

  • Handling uppercase codes in the powershell script
  • Modification to the DE version windows paths as they tricked Pandoc into thinking they were LATEX commands

Future plans:

  • The title page will need to handle different languages. Some basic translation strings should work well for this.
  • Ideally we should consider moving away from powershell but eh it works

Fixes: #31

I wanted to raise this PR before going into the weeds with the title page to check you're okay with everything so far @mcallegari

@yestalgia yestalgia marked this pull request as draft July 21, 2025 09:32
@yestalgia yestalgia marked this pull request as ready for review July 22, 2025 10:57
@yestalgia
Copy link
Collaborator Author

Update: I've managed to wrangle the logic for the title page to enable translations for it.

@sbenejam and @jpue can you please check the actions build for the translated PDFs and let me know if they're okay?

I'll quickly add a step to add the title page translation to the readme then I think we're good to go!

@sbenejam
Copy link
Contributor

sbenejam commented Jul 22, 2025 via email

@yestalgia
Copy link
Collaborator Author

The english version seems ok. The catalan and german versions are not ok. The indexes are not the same.

I think you tried to link some screenshots but it didn't work. What do you mean sorry?

@jpue
Copy link
Contributor

jpue commented Jul 24, 2025

I think he wanted to point out that the creation of the table of contents does not work properly for the translated versions.

qlcplus-docs-translations

@yestalgia
Copy link
Collaborator Author

I think he wanted to point out that the creation of the table of contents does not work properly for the translated versions.

Ahh good pickup. I'll investigate what's going on.

@sbenejam
Copy link
Contributor

sbenejam commented Jul 24, 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.

Support PDF Build for different languages

3 participants