FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-139588: Docs: fix PDF build by m-aciek · Pull Request #145480 · python/cpython · GitHub

/ cpython Public

gh-139588: Docs: fix PDF build - #145480

Merged
hugovk merged 6 commits into
python:mainfrom
m-aciek:pdf-svg-dedicated-venv
Mar 9, 2026
ConversationCommits (6)ChecksFiles changed
Merged

gh-139588: Docs: fix PDF build#145480
hugovk merged 6 commits into
python:mainfrom
m-aciek:pdf-svg-dedicated-venv

Conversation

m-aciek commented Mar 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fix PDF build of documentation.

  • Introduced optional sphinxcontrib-svg2pdfconverter dependency in Doc Makefile for PDF build.
  • Use sphinxcontrib.rsvgconverter from the package for converting of SVG graphics to PDF format.
  • Hide GIF graphics (animations) from PDF (LaTeX) build.

Refs. python/docs-community#182.

Test build is available here: https://github.com/m-aciek/python-docs-offline/actions/runs/22771888107. Artifacts include ZIP to download.

For the reference, problematic docs lines:

📚 Documentation preview 📚: https://cpython-previews--145480.org.readthedocs.build/

python-cla-bot Bot commented Mar 3, 2026 •
edited
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

bedevere-app Bot mentioned this pull request Mar 3, 2026
Closed
m-aciek force-pushed the pdf-svg-dedicated-venv branch from a930739 to f6981c9 Compare March 4, 2026 22:40
m-aciek changed the title gh-139588: Docs: PDF: dedicated venv and converting SVG to PDF using sphinxcontrib.rsvgconverter gh-139588: Docs: fix PDF build Mar 4, 2026
m-aciek marked this pull request as ready for review March 4, 2026 22:53
m-aciek mentioned this pull request Mar 4, 2026
Closed
hugovk reviewed Mar 5, 2026
View reviewed changes
Comment thread Doc/Makefile Outdated
Comment on lines +188 to +206
.PHONY: venv-pdf
venv-pdf:
@if [ -d $(VENVDIR_PDF) ] ; then \
echo "venv-pdf already exists."; \
echo "To recreate it, remove it first with \`make clean-venv'."; \
else \
set -e; \
echo "Creating venv in $(VENVDIR_PDF)"; \
if $(UV) --version >/dev/null 2>&1; then \
$(UV) venv --python=$(PYTHON) $(VENVDIR_PDF); \
VIRTUAL_ENV=$(VENVDIR_PDF) $(UV) pip install -r requirements-pdf.txt; \
else \
$(PYTHON) -m venv $(VENVDIR_PDF); \
$(VENVDIR_PDF)/bin/python3 -m pip install --upgrade pip; \
$(VENVDIR_PDF)/bin/python3 -m pip install -r requirements-pdf.txt; \
fi; \
echo "The venv has been created in the $(VENVDIR_PDF) directory"; \
fi

hugovk Mar 5, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This is essentially identical to venv, except instead of the REQUIREMENTS variable it hardcodes requirements-pdf.txt.

Can dist-pdf instead invoke venv and set REQUIREMENTS to requirements-pdf.txt?

m-aciek Mar 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Hm, it would be a nice simplification, though after the change two different virtualenvs would share the same location, incorrectly recognising existence of each other.

e.g.
(1) make html -> creates new venv (regular), builds html
(2) then make pdf -> it says venv already exists, therefore we don't rebuild the venv and try to build pdf without extra depenendency

m-aciek Mar 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Oh, sorry, actually I can also set VENVDIR, I will try it tomorrow.

m-aciek Mar 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Implemented in 9cb3ba4. I kept the venv-pdf target and reverted adding the dependency from dist-pdf to venv-pdf, for consequence with other dist- targets. Though I made venv-pdf reuse existing venv target definition.

m-aciek Mar 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

(test run after changes: https://github.com/m-aciek/python-docs-offline/actions/runs/22770351164)

hugovk Mar 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks, looks much better!

I'm wondering if we even need two named venvs.

Right now you can do:

(1) make html -> usual html build
(2) then make htmllive -> will also install the extra sphinx-autobuild dependency

Similarly for (3) make check -> installs pre-commit

Can we follow the same pattern?

m-aciek Mar 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thank you for catching that! Suggested approach is even more minimal. Implemented in 4b90701. I don't think we need to pin the package version as long as PDF build is not included in CPython's CI (otherwise I'd do it, for reproducible builds).

m-aciek commented Mar 5, 2026
View reviewed changes
Comment thread Doc/library/profiling.sampling.rst
m-aciek commented Mar 5, 2026
View reviewed changes
Comment thread Doc/library/profiling.sampling.rst
hugovk merged commit fc03cdc into python:main Mar 9, 2026
32 checks passed
m-aciek deleted the pdf-svg-dedicated-venv branch March 10, 2026 12:11
This was referenced Mar 10, 2026
Closed
Closed
This was referenced Mar 15, 2026
Merged
Closed

adorilson commented Mar 19, 2026

Copy link
Copy Markdown
Contributor

Amazing work, @m-aciek. Thank you.

  • Hide GIF graphics (animations) from PDF (LaTeX) build.

Is there a technical reason for it? Of course, I know that in PDF, animation is not possible.
But putting the final state of the animate would be a good thing. For instance, I think turtle docs could have animations in the HTML version, but in the PDF (and other static versions), the current static images.

m-aciek commented Mar 20, 2026 via email •
edited
Loading

Copy link
Copy Markdown
Contributor Author

ljfp pushed a commit to ljfp/cpython that referenced this pull request Apr 25, 2026
pythongh-139588: Docs: fix PDF build (python#145480)
e9ead32
m-aciek mentioned this pull request Jun 11, 2026
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk approved these changes
pablogsal Awaiting requested review from pablogsal pablogsal is a code owner
AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL