Fix #7: Add info to the README to generate the pdf version
authorJonathan Druart <jonathan.druart@gmail.com>
Wed, 10 Jan 2018 20:45:17 +0000 (17:45 -0300)
committerJonathan Druart <jonathan.druart@gmail.com>
Wed, 10 Jan 2018 20:46:11 +0000 (17:46 -0300)
README.md
source/conf.py

index e8678b9..64ace9c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ Documentation is generated with Sphinx.
 Setup
 -----
 
-> sudo apt-get install python3-sphinx  python3-sphinxcontrib.spelling 
+> sudo apt-get install python3-sphinx  python3-sphinxcontrib.spelling
 
 Outputing Docs
 --------------
@@ -22,6 +22,14 @@ Outputing Docs
 ### For an epub
 >  make epub
 
+### For a pdf (Work in progress)
+> apt install latexmk # the latexpdf builder needs it
+> apt install texlive-full # Attention, this is very huge
+                           # We should to list the individual packages we need
+> make latex # Generate the latex files
+> make latexpdf # Will generate the pdf file
+
+
 Other useful commands
 ---------------------
 
index 67e0a80..f4f1f6c 100644 (file)
@@ -440,3 +440,10 @@ epub_exclude_files = ['search.html']
 intersphinx_mapping = {'https://docs.python.org/': None}
 
 locale_dirs = ['../locales/']
+
+# Remove blank pages
+# https://evolvingweb.ca/blog/writing-documentation-restructured-text-and-sphinx
+latex_elements = {
+  'classoptions': ',oneside',
+  'babel': '\\usepackage[english]{babel}'
+}