DocsBrokenWindow POC: Convert static HTML output to PDF#8266
Closed
DocsBrokenWindow POC: Convert static HTML output to PDF#8266
Conversation
Contributor
Author
|
Closing in favour of other air-gapped/restricted approaches to docs. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR introduces a robust and flexible workflow for converting the static HTML output generated by Sphinx into clean, styled PDF documents, suitable for air-gapped and offline customer environments.
Key Technologies and Approach
WeasyPrint is used as the core HTML-to-PDF rendering engine. It offers:
BeautifulSoup is used to:
Custom PDF builder script (generate_pdfs.py):
Output Guides - 2 PDFs are generated:
Each PDF is self-contained, styled, and optimized for offline distribution. More iteration is needed on PDF look and feel.