Fix #7: Add info to the README to generate the pdf version

This commit is contained in:
Jonathan Druart 2018-01-10 17:45:17 -03:00
parent 4858a8887e
commit 2482c4476c
2 changed files with 16 additions and 1 deletions

View file

@ -8,7 +8,7 @@ Documentation is generated with Sphinx.
Setup Setup
----- -----
> sudo apt-get install python3-sphinx python3-sphinxcontrib.spelling > sudo apt-get install python3-sphinx python3-sphinxcontrib.spelling
Outputing Docs Outputing Docs
-------------- --------------
@ -22,6 +22,14 @@ Outputing Docs
### For an epub ### For an epub
> make 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 Other useful commands
--------------------- ---------------------

View file

@ -440,3 +440,10 @@ epub_exclude_files = ['search.html']
intersphinx_mapping = {'https://docs.python.org/': None} intersphinx_mapping = {'https://docs.python.org/': None}
locale_dirs = ['../locales/'] locale_dirs = ['../locales/']
# Remove blank pages
# https://evolvingweb.ca/blog/writing-documentation-restructured-text-and-sphinx
latex_elements = {
'classoptions': ',oneside',
'babel': '\\usepackage[english]{babel}'
}