Browse Source

Update the pdf plugin's documentation

Renato Cunha 8 years ago
parent
commit
fadeb851c3
3 changed files with 9 additions and 4 deletions
  1. 1 1
      Readme.rst
  2. 7 2
      pdf/Readme.rst
  3. 1 1
      pdf/pdf.py

+ 1 - 1
Readme.rst

@@ -128,7 +128,7 @@ Optimize images           Applies lossless compression on JPEG and PNG images
 
 Page View                 Pull page view count from Google Analytics.
 
-PDF generator             Automatically exports RST articles and pages as PDF files
+PDF generator             Automatically exports articles and pages as PDF files
 
 PDF Images                If an img tag contains a PDF, EPS or PS file as a source, this plugin generates a PNG preview which will then act as a link to the original file.
 

+ 7 - 2
pdf/Readme.rst

@@ -2,8 +2,8 @@
 PDF Generator
 -------------
 
-The PDF Generator plugin automatically exports reStructuredText articles and
-pages as PDF files as part of the site generation process. PDFs are saved to:
+The PDF Generator plugin automatically exports articles and pages as PDF files
+as part of the site generation process. PDFs are saved to:
 ``output/pdf/``
 
 Requirements
@@ -14,6 +14,11 @@ accomplished via::
 
 	pip install rst2pdf
 
+If you are converting Markdown sources to PDF, you also need the ``xhtml2pdf``
+module, which can be installed with::
+
+	pip install xhtml2pdf
+
 Usage
 -----
 

+ 1 - 1
pdf/pdf.py

@@ -3,7 +3,7 @@
 PDF Generator
 -------
 
-The pdf plugin generates PDF files from RST sources.
+The pdf plugin generates PDF files from reStructuredText and Markdown sources.
 '''
 
 from __future__ import unicode_literals, print_function