Skip to content

gh-139588: Docs: fix PDF build #145480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
m-aciek wants to merge 6 commits into
base: main
Choose a base branch
from
+19 −9
Open

gh-139588: Docs: fix PDF build #145480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6c6f528
Docs: PDF: convert SVG to PDF using sphinxcontrib.rsvgconverter
m-aciek Oct 19, 2025
273d2aa
Add support for PDF virtual environment in Makefile
m-aciek Mar 4, 2026
f6981c9
Hide GIFs from PDF builds
m-aciek Mar 4, 2026
83e4b7e
Bump svg2pdfconverter to 2.1.0
m-aciek Mar 5, 2026
9cb3ba4
Reuse existing venv target for PDF venv creation
m-aciek Mar 6, 2026
4b90701
Revert separate environment for PDF build, add _ensure-sphinxcontrib-…
m-aciek Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ htmlhelp: build
"build/htmlhelp/pydoc.hhp project file."

.PHONY: latex
latex: _ensure-sphinxcontrib-svg2pdfconverter
latex: BUILDER = latex
latex: build
@echo "Build finished; the LaTeX files are in build/latex."
Expand Down Expand Up @@ -231,7 +232,7 @@ dist-text:
@echo "Build finished and archived!"

.PHONY: dist-pdf
dist-pdf:
dist-pdf: _ensure-sphinxcontrib-svg2pdfconverter
# archive the A4 latex
@echo "Building LaTeX (A4 paper)..."
mkdir -p dist
Expand Down Expand Up @@ -292,6 +293,10 @@ _ensure-pre-commit:
_ensure-sphinx-autobuild:
$(MAKE) _ensure-package PACKAGE=sphinx-autobuild

.PHONY: _ensure-sphinxcontrib-svg2pdfconverter
_ensure-sphinxcontrib-svg2pdfconverter:
$(MAKE) _ensure-package PACKAGE=sphinxcontrib-svg2pdfconverter

.PHONY: check
check: _ensure-pre-commit
$(VENVDIR)/bin/python3 -m pre_commit run --all-files
Expand Down
1 change: 1 addition & 0 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
'linklint.ext',
'notfound.extension',
'sphinxext.opengraph',
'sphinxcontrib.rsvgconverter',
)
for optional_ext in _OPTIONAL_EXTENSIONS:
try:
Expand Down
20 changes: 12 additions & 8 deletions Doc/library/profiling.sampling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1194,10 +1194,12 @@ data, similar to the ``top`` command for system processes::
python -m profiling.sampling run --live script.py
python -m profiling.sampling attach --live 12345

.. figure:: tachyon-live-mode-2.gif
:alt: Tachyon live mode showing all threads
:align: center
:width: 100%
.. only:: not latex

.. figure:: tachyon-live-mode-2.gif
:alt: Tachyon live mode showing all threads
:align: center
:width: 100%

Live mode displays real-time profiling statistics, showing combined
Copy link
Contributor Author

@m-aciek m-aciek Mar 5, 2026

Choose a reason for hiding this comment

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

For what it's worth this caption is hidden in the PDF build.

Image

data from multiple threads in a multi-threaded application.
Expand All @@ -1217,10 +1219,12 @@ main table, showing instruction-level statistics for the currently selected
function. This panel displays which bytecode instructions are executing most
frequently, including specialized variants and their base opcodes.

.. figure:: tachyon-live-mode-1.gif
:alt: Tachyon live mode with opcode panel
:align: center
:width: 100%
.. only:: not latex
Copy link
Contributor Author

@m-aciek m-aciek Mar 5, 2026

Choose a reason for hiding this comment

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

Image


.. figure:: tachyon-live-mode-1.gif
:alt: Tachyon live mode with opcode panel
:align: center
:width: 100%

Live mode with ``--opcodes`` enabled shows an opcode panel with a bytecode
instruction breakdown for the selected function.
Expand Down
Loading