Use Ubuntu 20.04, lualatex for readthedocs builds (#9242)

This commit is contained in:
andrewdotn 2021-10-30 08:21:14 -06:00 committed by GitHub
parent 69b0a7b306
commit 1824349f74
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 21 additions and 4 deletions

View File

@ -1,13 +1,15 @@
version: 2 version: 2
python: python:
version: 3.7
install: install:
- requirements: doc/en/requirements.txt - requirements: doc/en/requirements.txt
- method: pip - method: pip
path: . path: .
build: build:
os: ubuntu-20.04
tools:
python: "3.9"
apt_packages: apt_packages:
- inkscape - inkscape

1
changelog/9242.doc.rst Normal file
View File

@ -0,0 +1 @@
Upgrade readthedocs configuration to use a [newer Ubuntu version](https://blog.readthedocs.com/new-build-specification/) with better unicode support for PDF docs.

View File

@ -19,6 +19,7 @@ import ast
import os import os
import shutil import shutil
import sys import sys
from textwrap import dedent
from typing import List from typing import List
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
@ -39,9 +40,22 @@ autodoc_member_order = "bysource"
autodoc_typehints = "description" autodoc_typehints = "description"
todo_include_todos = 1 todo_include_todos = 1
# Use a different latex engine due to possible Unicode characters in the documentation: latex_engine = "lualatex"
# https://docs.readthedocs.io/en/stable/guides/pdf-non-ascii-languages.html
latex_engine = "xelatex" latex_elements = {
"preamble": dedent(
r"""
\directlua{
luaotfload.add_fallback("fallbacks", {
"Noto Serif CJK SC:style=Regular;",
"Symbola:Style=Regular;"
})
}
\setmainfont{FreeSerif}[RawFeature={fallback=fallbacks}]
"""
)
}
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------