Registry / serialization / sphinx-simplepdf

sphinx-simplepdf

JSON →
library1.7.0pypypi✓ verified 80d ago

An easy-to-use PDF Builder for Sphinx with a modern PDF theme. Version 1.7.0 supports Sphinx 4-7 and uses WeasyPrint or wkhtmltopdf under the hood. Moderate release cadence.

pip install sphinx-simplepdf
INSTALL
IMPORT
SIG · SPHINX-SIMPLEPDF
S
sphinx-simplepdf
serializationpythonv1.7.0
Install
8.7s avg
Import
Disk
199MB
Pass rate
5/ 10
Env Coverage5 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v1.7.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
build_error
glibc
py 3.103.95 runs
installs and imports cleanly · install 8.7s · import 0.000s · 195MB
199MB installed
● package 199MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

IfBuilderDirective
from sphinx_simplepdf import IfBuilderDirective
from sphinx_simplepdf.builder import SimplePdfBuilder
setup
from sphinx_simplepdf import setup
from sphinx_simplepdf.builder import SimplePdfBuilder

Enable the extension in your Sphinx conf.py, then build using the 'simplepdf' builder.

extensions = ['sphinx_simplepdf'] # Optional: configure output simplepdf_documents = [ { 'doc': 'index', 'title': 'My Project', 'author': 'Author Name' } ] # Build with: sphinx-build -b simplepdf . _build/pdf
Debug
Known issues
breakingVersion 1.0.0 renamed the builder from 'pdflatex' to 'simplepdf'. Old command 'sphinx-build -b pdflatex ...' will fail.
fix
Use 'sphinx-build -b simplepdf ...'
affects: <1.0.0
deprecatedSupport for wkhtmltopdf is deprecated in favor of WeasyPrint. wkhtmltopdf may be removed in future releases.
fix
Switch to WeasyPrint: pip install weasyprint and remove wkhtmltopdf config.
affects: >=1.5.0
gotchaIf you set 'latex_engine' in conf.py, it may cause conflicts. sphinx-simplepdf ignores it but Sphinx emits a warning.
fix
Remove or comment out 'latex_engine' from conf.py.
affects: all
Upgrade
Version history
1.7.0latest on PyPI · released Dec 2, 2025
Audit
Dependencies
SphinxrequiredCore dependency, extension registers with Sphinx
weasyprintoptionalDefault PDF renderer (or use wkhtmltopdf)
wkhtmltopdfoptionalAlternative PDF renderer
Agent activity
17 hits · last 30 days
node
14
Resources
sphinx-simplepdf — pip install sphinx-simplepdf · libregistry