瀏覽代碼

Add a link to rst2pdf's manual for reference. Fixes #76, fixes #77.

Renato Cunha 9 年之前
父節點
當前提交
09f36adccf
共有 1 個文件被更改,包括 10 次插入3 次删除
  1. 10 3
      pdf/Readme.rst

+ 10 - 3
pdf/Readme.rst

@@ -11,15 +11,22 @@ Requirements
 You should ensure you have the ``rst2pdf`` module installed::
 
 	pip install rst2pdf
-	
+
 Usage
 -----
-In order to use this plugin you should add the following to your config file::
+To customize the pdf output, you can use the following settings in your
+configuration file::
 
 	PDF_STYLE = ''
 	PDF_STYLE_PATH = ''
 
+``PDF_STYLE_PATH`` defines a new path where rst2pdf will look for style sheets,
+while ``PDF_STYLE`` defines which style you want to use. For a description of
+the available styles, please read `rst2pdf's documentation`_.
+
+.. _rst2pdf's documentation: http://rst2pdf.ralsina.me/handbook.html#styles
+
 Known Issues
 ------------
-Relative links in the form of ``|filename|images/test.png`` are not yet handled 
+Relative links in the form of ``|filename|images/test.png`` are not yet handled
 by the pdf generator