.. sphinx-simplepdf documentation master file, created by sphinx-quickstart on Wed Aug 17 12:50:37 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Sphinx-SimplePDF ================ This Sphinx extension provides an easy way to build beautiful PDFs based on CSS rules. It contains: * A PDF specific, CSS based Sphinx theme: ``sphinx_simplepdf``. * A Sphinx builder, called ``simplepdf`` * :ref:`Directives ` to * control different structures and content for ``HTML`` and ``PDF`` builds. * embed PDF inside HTML views. It is using `weasyprint `__ as PDF generator. .. note:: This extension is in a beta phase. It is not bug free and documentation is also missing some minor stuff. You can help us to make it better by reporting bugs or by providing code/docs changes via a PR. The code is available on github: `useblocks/sphinx-simplepdf `__ Showcase -------- | **Sphinx-SimplePDF Documentation** | The PDF is based on the current HTML documentation. | :download:`Download PDF ` .. pdf-include:: _static/Sphinx-SimplePDF.pdf#view=Fit | **Sphinx-SimplePDF Demo** | A PDF containing different content types to check the handling of them by Sphinx-SimplePDF. | :download:`Download PDF ` .. pdf-include:: _static/Sphinx-SimplePDF-DEMO.pdf#view=Fit .. if-builder:: simplepdf .. toctree:: quickstart installation building configuration directives css tech_details changelog license .. if-builder:: HTML .. include:: quickstart.rst Why another PDF builder? ------------------------ You can use the Sphinx Latex builder to generate PDFs. And there is also the great `rinohtype `__ library. But both have some drawbacks, which we try to avoid with this solution. Latex distributions are quite big and Latex as language may not be the language of choice for everybody. rinohtype makes a lot of things easier, but it does not support additional Sphinx extensions very well (if they are using visitor-functions). For instance is it hard to get PlantUML running with rinohtype. But for sure, there are also scenarios where **Sphinx-SimplePDF** may not be the best solution. So if you are unhappy with **Sphinx-SimplePDF** please try the others as well :) One last thing ... ------------------ This theme is heavily based on the excellent work of `Nekmo `__ for the `Sphinx Business Theme `__. Without this work, this theme would never exist. Thanks for it ♥ .. toctree:: :caption: Content :maxdepth: 3 installation building configuration directives css tech_details examples/index changelog license