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

create pdf out of the documentation #930

Merged
merged 2 commits into from
Nov 21, 2023
Merged

create pdf out of the documentation #930

merged 2 commits into from
Nov 21, 2023

Conversation

HarshCasper
Copy link
Member

No description provided.

Copy link

github-actions bot commented Nov 21, 2023

🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-930.surge.sh 🎊

@HarshCasper HarshCasper requested a review from whummer November 21, 2023 06:51
Copy link
Member

@whummer whummer left a comment

Choose a reason for hiding this comment

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

Looks great, kudos for putting this together so quickly @HarshCasper ! 🚀

Added a few tiny comments, nothing that should block the merge..


Small note: seems like the border on the PDF pages is pretty small, hence the content sits very much at the top of the page (at least in my PDF reader). No need to change it for now though, could be done in a future iteration. 👍

Example 1:
image

Example 2:
image

scripts/generate_pdf_output.py Show resolved Hide resolved
scripts/generate_pdf_output.py Outdated Show resolved Hide resolved
'developing-extensions',
'official-extensions',
'cloud-pods',
'getting-started',
Copy link
Member

Choose a reason for hiding this comment

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

seems to be a duplicate with line 125 - on purpose?

Copy link
Member Author

Choose a reason for hiding this comment

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

Seems like a bug. Will fix later in follow-up PR

scripts/pdf_list.py Show resolved Hide resolved
source_directory = "w2pdf_output"
target_directory = "final"
find_and_copy_pdfs(source_directory, target_directory)
merge_pdfs(doc_list, "localstack_docs.pdf")
Copy link
Member

@whummer whummer Nov 21, 2023

Choose a reason for hiding this comment

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

nit: we could add a small check to discover pages that are contained in the target_directory, but not contained in doc_list (and then either print a warning, or fail the script), to make it easier to maintain the list in pdf_list.py over time. (not super critical for now, though..)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, will follow up on the other PR 👍

@HarshCasper HarshCasper merged commit bbfe914 into main Nov 21, 2023
3 checks passed
@HarshCasper HarshCasper deleted the docs-pdf branch November 21, 2023 09:26
HarshCasper added a commit that referenced this pull request Nov 21, 2023
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.

2 participants