sphinx_pyppeteer_builder

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.

Install

You can install it with pip:

pip install sphinx_pyppeteer_builder

Or with setup.py:

python setup.py install
pyppeteer-install

Configuration

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'
    }
}

Use

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.

Metadata

Release files for sphinx_pyppeteer_builder 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx_pyppeteer_builder 1.0.0
File	Size	Uploaded
sphinx_pyppeteer_builder-1.0.0.tar.gz	139.6 kB	Sep 19, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx_pyppeteer_builder 1.0.0
File	Interpreter	ABI	Platform	Reset
sphinx_pyppeteer_builder-1.0.0-py3-none-any.whl 28.7 kB Sep 19, 2023	Python 3	none	any	Details

Total release size: 168.3 kB

Release files / sphinx_pyppeteer_builder-1.0.0.tar.gz

Download URL	sphinx_pyppeteer_builder-1.0.0.tar.gz
Size	139.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`02d19d8efe54eba976afb05c245cb07a3ee97f221d0489c7fcc56448b3f168ee`
BLAKE2b-256 checksum How to use checksums	`01a524b0aa429ec5f07df5db45d510df77bb4283e841ec860c0d5c5b93822055`
Upload date	Sep 19, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`python-requests/2.31.0`

Release files / sphinx_pyppeteer_builder-1.0.0-py3-none-any.whl

Download URL	sphinx_pyppeteer_builder-1.0.0-py3-none-any.whl
Size	28.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`41aa6f3b5789d0be631256eede52190c4288626078723f975a21d1c789379bd1`
BLAKE2b-256 checksum How to use checksums	`c544fbcea12d117761c35de6b41cff337c0ee1d62bb42b2e7b9f27c5bd9805bd`
Upload date	Sep 19, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`python-requests/2.31.0`