Skip to content

Give the PDF the same cover and layout as the other manuals - #3

Merged
embarquech merged 1 commit into
mainfrom
docs/pdf-cover-and-layout
Sep 16, 2026
Merged

embarquech merged 1 commit into
mainfrom
docs/pdf-cover-and-layout

Conversation

@mmlado

@mmlado mmlado commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator

Fixes the PDF after the review of the first published one, so it matches the cryptnox-cli and SDK manuals.

  • Cover page like the other manuals: logo, title, release and date, no author line. The navy cover logo is generated from the site's white SVG at build time (cairosvg + Pillow, now in requirements.txt), the same way cryptnox-cli does it, so only the SVG is committed.
  • No blank filler pages (oneside,openany).
  • The index page's site-only parts are no longer in the PDF: the "Download this documentation as a PDF" link, the landing card and the "Other resources" list are wrapped in .. only:: html. The three articles are now chapters 1 to 3, with the table of contents on page 2.
  • Same page furniture as cryptnox-cli: sans-serif body, left-aligned chapter headings, running header with the manual title, copyright footer with the page number.

Built locally: sphinx-build -W for HTML is clean and the site index is unchanged (download link, card, article list, sidebar); latexpdf gives 18 pages with no blank pages.

Not changed: the "Related" list at the end of each article stays in the PDF, since it is part of the article. Say if those should go too.

🤖 Generated with Claude Code

@mmlado
mmlado requested a review from embarquech September 14, 2026 16:10
Take the LaTeX setup from the cryptnox-cli manual: cover page with the
logo, title, release and date, no filler pages, sans-serif body,
left-aligned chapter headings, running header and copyright footer.
The dark cover logo is generated from the site SVG at build time, so
cairosvg and Pillow join the build requirements.

Keep the site-only parts of the index page out of the PDF: the
download link, the landing card and the Other resources list. The
three articles are now the PDF's chapters instead of sitting under a
chapter made of the index page.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@embarquech
embarquech force-pushed the docs/pdf-cover-and-layout branch from 6d1817e to 7743f2d Compare September 16, 2026 10:00
@embarquech
embarquech merged commit c930767 into main Sep 16, 2026
1 check passed
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