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 0.1.1

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 0.1.1
File	Size	Uploaded	Provenance	Actions
sphinx_pyppeteer_builder-0.1.1.tar.gz	25.1 kB	Jul 7, 2020	Without provenance	Details for sphinx_pyppeteer_builder-0.1.1.tar.gz

Release files / sphinx_pyppeteer_builder-0.1.1.tar.gz

Download URL	sphinx_pyppeteer_builder-0.1.1.tar.gz
Size	25.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`966e9cda7254fd03df9624bf282615daefd87b5d6fb0094f40a7e6662335d3dd`
BLAKE2b-256 checksum How to use checksums	`642ec95cf4bdfcb394f1a5e9149be6cdd022b88f2f409a844c53ddebaa2d87f0`
Upload date	Jul 7, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10`

Security for sphinx_pyppeteer_builder 0.1.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.