-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
feat/scripts: support generating PDFs for platforms #11195
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
sebastiaanspeck
approved these changes
Oct 23, 2023
Magrid0
approved these changes
Oct 23, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
MasterOdin
reviewed
Oct 23, 2023
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
MasterOdin
approved these changes
Oct 23, 2023
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Issues/PRs modifying the documentation.
tooling
Helper tools, scripts and automated processes.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
As discussed in the chatroom, this PR adds a way to generate custom PDFs for specific platforms manually. Currently, we use
python3 render.py <../../pages>
to generate PDFs (tldr-book.pdf
by default) and there is a-o
or--output
flag to give a custom name to the PDF.This PR adds a new optional flag
-p
or--platform
, allowing pages to be generated for the specified platform alone. For example,python3 render.py ../../pages -p android
will generate a PDF file namedtldr-book-android.pdf
.You can pass multiple platforms as arguments, for example,
python3 render.py ../../pages -p android sunos
will generate a PDF file namedtldr-book-android+sunos.pdf
.In the case of custom file names, the platform name is just appended behind the filename, for example
python3 render.py ../../pages -p android sunos -o tldr-book.pdf
will generate a file namedtldr-book-android+sunos.pdf
.Reference Outputs
Reference assets
Assets generated in the above steps:
tldr-book-android+sunos.pdf
tldr-books-android.pdf
Checklist