mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/README: Add some hints for PDF docs generation.

This commit is contained in:
Paul Sokolovsky 2016-06-02 00:08:47 +03:00
parent 09f764dc04
commit e456b2cc94
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/README.md
View File

@ -26,3 +26,15 @@ In `micropython/docs`, build the docs:
Where `<port_name>` can be `unix`, `pyboard`, `wipy` or `esp8266`.
You'll find the index page at `micropython/docs/build/<port_name>/html/index.html`.
PDF manual generation
---------------------
This can be achieved with:
make MICROPY_PORT=<port_name> latexpdf
but require rather complete install of LaTeX with various extensions. On
Debiab/Ubuntu, try (500MB+ download):
apt-get install texlive-latex-recommended texlive-latex-extra