Skip to content

Fix PDF build by removing incompatible emoji characters - #2152

Open
nehasanoor2006-collab wants to merge 1 commit into
pypa:mainfrom
nehasanoor2006-collab:main
Open

nehasanoor2006-collab wants to merge 1 commit into
pypa:mainfrom
nehasanoor2006-collab:main

Conversation

@nehasanoor2006-collab

@nehasanoor2006-collab nehasanoor2006-collab commented Oct 6, 2026 •

Copy link
Copy Markdown

Description

Fixes #2031.

The PDF build uses Sphinx's LaTeX builder with pdflatex, which has limited support for Unicode characters such as emoji. These characters are emitted into the generated LaTeX source and can cause the LaTeX build to fail during the passes required to generate the table of contents.

This change removes decorative emoji characters from the documentation and sample workflow display names so that the default PDF build can complete without encountering unsupported Unicode characters.

Changes

  • Removed decorative emoji from documentation pages.
  • Removed emoji from display-only workflow/job/step names in the sample GitHub Actions workflow.
  • No Sphinx or LaTeX configuration changes were made.

Testing

  • git diff --check passes.
  • Sphinx LaTeX source generation succeeds.
  • The full PDF build could not be run locally because the environment does not have the required TeX toolchain installed.

📚 Documentation preview 📚: https://python-packaging-user-guide--2152.org.readthedocs.build/en/2152/

@merwok

merwok commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

This removes some personality, even changes output from a tool.

What about this alternative idea: keep the emojis, hook a script that replaces them with ascii emoticons or removes them for the PDF build.

(Please disclose if you use chatbots to create code or messages)

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.

Sphinx PDF missing contents

2 participants