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

use alpaka.png instead alpaka.pdf as logo in the sphix doc latex build #2098

Merged
merged 1 commit into from
Aug 28, 2023

Conversation

SimeonEhrig
Copy link
Member

The readthedocs builder fails at building a pdf version of the documentation, if more than one pdf file is located in the build folder. Before this PR, it copies the alpaka.pdf (logo) to the build folder and generates the alpaka-doc.pdf (complete documentation).

The readthedocs builder fails at building a pdf version of the documentation, if more than one pdf file is located in the build folder. Before this PR, it copies the `alpaka.pdf` (logo) to the build folder and generates the `alpaka-doc.pdf` (complete documentation).
Copy link
Member

@bernhardmgruber bernhardmgruber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it weird that we cannot have vector graphics in PDF format when generating the documentation via latex. However, if this PR fixes building the documentation, we should go for it. Please create an issue though, that the latex build should use the pdf image so someone can have a look at it in the future.

@SimeonEhrig
Copy link
Member Author

Actual, there is already PR, which should allow to use multiple pdf's in the build folder: readthedocs/readthedocs.org#10438

@SimeonEhrig
Copy link
Member Author

I find it weird that we cannot have vector graphics in PDF format when generating the documentation via latex. However, if this PR fixes building the documentation, we should go for it. Please create an issue though, that the latex build should use the pdf image so someone can have a look at it in the future.

Done in #2100 If this PR solves the build problem, we can also enable the pdf build for PRs. So we will see immediately, if the pdf build fails.

@bernhardmgruber
Copy link
Member

If this PR solves the build problem, we can also enable the pdf build for PRs. So we will see immediately, if the pdf build fails.

Please go ahead with this! We should know when the documentation can no longer be built!

@bernhardmgruber bernhardmgruber merged commit 5a889b5 into alpaka-group:develop Aug 28, 2023
21 checks passed
@SimeonEhrig
Copy link
Member Author

This PR solved the build failure on the development branch. I also enabled pdf and epub builds for PR previews. At least I think I did it. The descriptions is a little bit small.

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

Successfully merging this pull request may close these issues.

2 participants