{"id":24626,"library":"sphinx-simplepdf","title":"sphinx-simplepdf","description":"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.","status":"active","version":"1.7.0","language":"python","source_language":"en","source_url":"https://github.com/sphinx-toolbox/sphinx-simplepdf","tags":["sphinx","pdf","documentation","builder"],"install":[{"cmd":"pip install sphinx-simplepdf","lang":"bash","label":"PyPi"}],"dependencies":[{"reason":"Core dependency, extension registers with Sphinx","package":"Sphinx","optional":false},{"reason":"Default PDF renderer (or use wkhtmltopdf)","package":"weasyprint","optional":true},{"reason":"Alternative PDF renderer","package":"wkhtmltopdf","optional":true}],"imports":[{"note":"Correct import for the builder class, though typically configured via conf.py with 'simplepdf' as the builder name.","symbol":"SimplePdfBuilder","correct":"from sphinx_simplepdf.builder import SimplePdfBuilder"}],"quickstart":{"code":"extensions = ['sphinx_simplepdf']\n\n# Optional: configure output\nsimplepdf_documents = [\n    {\n        'doc': 'index',\n        'title': 'My Project',\n        'author': 'Author Name'\n    }\n]\n\n# Build with: sphinx-build -b simplepdf . _build/pdf","lang":"python","description":"Enable the extension in your Sphinx conf.py, then build using the 'simplepdf' builder."},"warnings":[{"fix":"Use 'sphinx-build -b simplepdf ...'","message":"Version 1.0.0 renamed the builder from 'pdflatex' to 'simplepdf'. Old command 'sphinx-build -b pdflatex ...' will fail.","severity":"breaking","affected_versions":"<1.0.0"},{"fix":"Switch to WeasyPrint: pip install weasyprint and remove wkhtmltopdf config.","message":"Support for wkhtmltopdf is deprecated in favor of WeasyPrint. wkhtmltopdf may be removed in future releases.","severity":"deprecated","affected_versions":">=1.5.0"},{"fix":"Remove or comment out 'latex_engine' from conf.py.","message":"If you set 'latex_engine' in conf.py, it may cause conflicts. sphinx-simplepdf ignores it but Sphinx emits a warning.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Add 'sphinx_simplepdf' to extensions list in conf.py and install package: pip install sphinx-simplepdf","cause":"Extension not enabled in conf.py or not installed.","error":"Builder name 'simplepdf' not found"},{"fix":"pip install weasyprint (or install system dependencies for WeasyPrint).","cause":"WeasyPrint is required but not installed.","error":"ModuleNotFoundError: No module named 'weasyprint'"},{"fix":"Ensure you installed sphinx-simplepdf (>=1.0.0) and added it as string in extensions list.","cause":"Wrong import or old version of the package.","error":"AttributeError: module 'sphinx_simplepdf' has no attribute 'setup'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}