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

Fail on missing asciidoctor pdf command #3819

Merged
merged 2 commits into from
May 29, 2024

Conversation

pderop
Copy link
Contributor

@pderop pderop commented May 29, 2024

When you want to build the documentation, you can using the following command:

 ./gradlew docs -PforcePdf

Now, PDF generation requires the asciidoctor-pdf command to be available in the PATH.
This PR simply makes the build failing in case the asciidoctor-pdf command is not available from the PATH.
Also, updated README.md to indicate that this command needs to be available when generating PDF from Antora documentation.

@pderop pderop added the type/documentation A documentation update label May 29, 2024
@pderop pderop added this to the 3.7.0-M3 milestone May 29, 2024
@pderop pderop self-assigned this May 29, 2024
@pderop pderop requested a review from a team as a code owner May 29, 2024 14:05
Copy link
Member

@chemicL chemicL left a comment

Choose a reason for hiding this comment

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

Thanks!

@chemicL chemicL merged commit 6a2b97a into reactor:main May 29, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants