Skip to content

Comments

Feature : tutorials to pdf#734

Open
the-matrixneo wants to merge 1 commit intoprecice:masterfrom
the-matrixneo:feature/add-tutorials-to-pdf
Open

Feature : tutorials to pdf#734
the-matrixneo wants to merge 1 commit intoprecice:masterfrom
the-matrixneo:feature/add-tutorials-to-pdf

Conversation

@the-matrixneo
Copy link

@the-matrixneo the-matrixneo commented Feb 22, 2026

I have tested the implementation locally by ensuring the generated prince-list.txt correctly populates with URIs for both documentation and tutorials. The logic supports the full nested structure of the tutorial sidebar.

Please review the merge request
Issue no: #468

@MakisH
Copy link
Member

MakisH commented Feb 22, 2026

Thank you for the contribution! This is useful.

In the PDF I built from this PR, tutorials start from page 443. In the table of contents, I don't see anything about the tutorials. Or should I look specifically somewhere?

Also, the Quickstart tutorial (only), appears to have larger font. I guess this is because it does not yet have a sidebar (intentionally, but maybe we can rethink that decision), but then this is a separate issue.

As a side effect of including the tutorials (which have many pictures), the resulting PDF is 17MB (compared to the previous 3-4MB). If you see any easy way to reduce the size, that would be great!

In any case, I would appreciate it if you could post screenshots of any updates, or share the PDF itself, as it is currently a bit cumbersome for me to build locally.

@the-matrixneo
Copy link
Author

I will add tutorial_sidebar loop to tocpage.html (pg 443+)

To solve the size issue caused by tutorial pictures, I was confused a bit to either use an argument or to implement some variable technique.

docs: I believe we should explicitly list these optimization techniques in docs-meta-publish-to-pdf.md as this will serve as a guide for future work to ensure that the PDF remains lightweight.

@hanzalahwaheed
Copy link
Contributor

@the-matrixneo hey! solid PR!

PS. minor suggestion regarding commit history. I think its better to use git rebase if trying to bring your feature branch upto date with the master branch. This keeps the commit history much much cleaner and pays in multiples later on. You could also git squash all the commits into a single commit.

@MakisH MakisH added GSoC Contributed in the context of the Google Summer of Code technical Technical issues on the website labels Feb 23, 2026
- Updated prince-list.txt and tocpage.html to include tutorials
- Integrated --raster-images-res 150 flag in pdf-docs.sh to reduce size
- Documented optimizations in docs-meta-publish-to-pdf.md
@the-matrixneo the-matrixneo force-pushed the feature/add-tutorials-to-pdf branch from 07ca382 to efe296d Compare February 24, 2026 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GSoC Contributed in the context of the Google Summer of Code technical Technical issues on the website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants