Readme.rst 877 B

123456789101112131415161718192021222324252627282930313233
  1. -------------
  2. PDF Generator
  3. -------------
  4. The PDF Generator plugin automatically exports RST articles and pages
  5. 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::
  10. pip install rst2pdf
  11. Usage
  12. -----
  13. To customize the pdf output, you can use the following settings in your
  14. configuration file::
  15. PDF_STYLE = ''
  16. PDF_STYLE_PATH = ''
  17. ``PDF_STYLE_PATH`` defines a new path where rst2pdf will look for style sheets,
  18. while ``PDF_STYLE`` defines which style you want to use. For a description of
  19. the available styles, please read `rst2pdf's documentation`_.
  20. .. _rst2pdf's documentation: http://rst2pdf.ralsina.me/handbook.html#styles
  21. Known Issues
  22. ------------
  23. Relative links in the form of ``|filename|images/test.png`` are not yet handled
  24. by the pdf generator