ebu / ear-production-suite

The EAR Production Suite is a set of VST® plugins and tools for producing immersive and personalizable audio content suitable for any Next Generation Audio codec. It is based on the Audio Definition Model (ITU-R BS.2076) and the ITU ADM Renderer (ITU-R BS.2127) and enables monitoring on any ITU-R BS.2051 loudspeaker configuration.
https://ear-production-suite.ebu.io/
GNU General Public License v3.0
101 stars 19 forks source link

Generate PDFs on CI #274

Closed firthm01 closed 4 months ago

firthm01 commented 4 months ago

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.

rsjbailey commented 4 months ago

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