Readme.rst 942 B

12345678910111213141516171819202122232425262728293031323334353637
  1. -------------
  2. PDF Generator
  3. -------------
  4. The PDF Generator plugin automatically exports reStructuredText articles and
  5. pages as PDF files as part of the site generation process. PDFs are saved to:
  6. ``output/pdf/``
  7. Requirements
  8. ------------
  9. You should ensure you have the ``rst2pdf`` module installed, which can be
  10. accomplished via::
  11. pip install rst2pdf
  12. Usage
  13. -----
  14. To customize the PDF output, you can use the following settings in your
  15. Pelican configuration file::
  16. PDF_STYLE = ''
  17. PDF_STYLE_PATH = ''
  18. ``PDF_STYLE_PATH`` defines a new path where ``rst2pdf`` will look for style
  19. sheets, while ``PDF_STYLE`` specifies the style you want to use. For a
  20. description of the available styles, please read the `rst2pdf documentation`_.
  21. .. _rst2pdf documentation: http://rst2pdf.ralsina.me/handbook.html#styles
  22. Known Issues
  23. ------------
  24. Relative links in the form of ``|filename|images/test.png`` are not yet handled
  25. by the PDF generator.