Skip to main content

A Sphinx PDF builder using pyppeteer

Project description

Sphinx Pyppeteer builder is a PDF generator for Sphinx without usage of LaTeX. It uses Pyppeteer, a wrapper to control a web browser. It supports Chromium for now.


You can install it with pip:

pip install sphinx_pyppeteer_builder

Or with

python install


You can configure your output with these options:

  • pyppeteer_basename

  • pyppeteer_theme

  • pyppeteer_theme_options

  • pyppeteer_title

  • pyppeteer_theme_path

  • pyppeteer_short_title

  • pyppeteer_style

  • pyppeteer_css_files

  • pyppeteer_show_copyright

  • pyppeteer_show_sphinx

Each one has the same behavior of its equivalent for html builder.

In addition, you can set pyppeteer_pdf_options var. This dict is passed as is to the pdf coroutine. Default values are:

pyppeteer_pdf_options = {
    'printBackground': True,
    'format': 'A4',
    'margin': {
        'top': '20mm',
        'bottom': '20mm',
        'left': '10mm',
        'right': '10mm'


Just launch the following:

make pyppeteer

Why an other PDF builder for Sphinx?

LaTeX is really hard to use and to personalize. There’s also an other project to make PDF without LaTeX but it is not based on CSS stylesheets.

Web browser to generate PDF have all new generation CSS specs implemented. You can use sphinx_weasyprint_builder instead if you don’t want a full browser.

This plugin is just singlehtml output with conversion to PDF.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_pyppeteer_builder-1.0.0.tar.gz (139.6 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page