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

Build docs #49

Merged
merged 4 commits into from
Jun 24, 2024
Merged

Build docs #49

merged 4 commits into from
Jun 24, 2024

Conversation

mardy
Copy link
Collaborator

@mardy mardy commented Jun 19, 2024

  • Build the opengx PDF file from the LaTeX source files.
  • Remove the png images, since they can be rebuilt from the SVGs.
  • Add a CI workflow to build the PDF documentation and publish it as an artifact.

@WinterMute
Copy link
Member

Why is build-essential needed for building docs? Can we get rid of this?

Personally I'm not really a massive fan of installing software as part of any automated workflow, I think it's wasteful in terms of energy and network use and would prefer to avoid it if at all possible. Making a docker just for cmake, imagemagick and texlive-latex-extra is probably just as wasteful. Can this stuff be cached somehow?

@mardy
Copy link
Collaborator Author

mardy commented Jun 21, 2024

Why is build-essential needed for building docs? Can we get rid of this?

It turns out we can, I removed it.

Personally I'm not really a massive fan of installing software as part of any automated workflow, I think it's wasteful in terms of energy and network use and would prefer to avoid it if at all possible. Making a docker just for cmake, imagemagick and texlive-latex-extra is probably just as wasteful. Can this stuff be cached somehow?

I'm not an expert on Github actions, so I'm not sure. But I now made a change to the action rules, so that the doc workflow starts only if some files under doc/ get modified. BTW, the workflow completes very quickly, so maybe it's not as resource intensive as it may seem.

@davidgfnet
Copy link

Nice! It is cool you plan on update the docs :)
LGTM!

@WinterMute WinterMute merged commit de7d79e into devkitPro:master Jun 24, 2024
3 checks passed
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