summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStewart C. Russell <scruss@scruss.com>2021-01-17 22:56:29 -0500
committerDamien George <damien@micropython.org>2022-06-21 14:49:13 +1000
commitf12754af06c83f06f2651f50109b84a9b700e12a (patch)
tree9828c9be96af0388205147774a3ffecb707221bd /docs
parent9175482f29264b017534902bb65e23a2d6485006 (diff)
docs: Set LaTeX engine to XeLaTeX for PDF generation.
Also added to suggested packages list for PDF build. See comment in Sphinx project for (some) details: https://github.com/sphinx-doc/sphinx/pull/5693#pullrequestreview-180444650
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md6
-rwxr-xr-xdocs/conf.py2
2 files changed, 5 insertions, 3 deletions
diff --git a/docs/README.md b/docs/README.md
index 1591911c3..892726ba1 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -47,7 +47,7 @@ This can be achieved with:
make latexpdf
-but require rather complete install of LaTeX with various extensions. On
-Debian/Ubuntu, try (500MB+ download):
+but requires a rather complete install of LaTeX with various extensions. On
+Debian/Ubuntu, try (1GB+ download):
- apt-get install texlive-latex-recommended texlive-latex-extra
+ apt install texlive-latex-recommended texlive-latex-extra texlive-xetex texlive-fonts-extra cm-super xindy
diff --git a/docs/conf.py b/docs/conf.py
index d0c989eea..a7a4ab08c 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -259,6 +259,8 @@ latex_documents = [
# If false, no module index is generated.
#latex_domain_indices = True
+# Enable better Unicode support so that `make latexpdf` doesn't fail
+latex_engine = "xelatex"
# -- Options for manual page output ---------------------------------------