From 28c86760da4173861ce89388e1122f26ddfbbdcf Mon Sep 17 00:00:00 2001 From: Dominik Csapak Date: Fri, 26 Feb 2021 15:45:34 +0100 Subject: [PATCH] docs: use mathjax library from debian package instead of CDN By default, sphinx embeds the cloudflare CDN version of mathjax. This is bad for privacy, webistes enforcing cross-site origin protection and in environments with no WAN access. Luckily there's a Debian package we can use instead. The config is the default sphinx config used. Reported-by: Thomas Lamprecht Signed-off-by: Dominik Csapak Signed-off-by: Thomas Lamprecht --- debian/control | 1 + debian/control.in | 1 + debian/proxmox-backup-docs.links | 1 + docs/conf.py | 3 +++ 4 files changed, 6 insertions(+) diff --git a/debian/control b/debian/control index 7f6443d7..5494627b 100644 --- a/debian/control +++ b/debian/control @@ -141,6 +141,7 @@ Package: proxmox-backup-docs Build-Profiles: Section: doc Depends: libjs-extjs, + libjs-mathjax, ${misc:Depends}, Architecture: all Description: Proxmox Backup Documentation diff --git a/debian/control.in b/debian/control.in index b4b4d22e..c6aee8ca 100644 --- a/debian/control.in +++ b/debian/control.in @@ -38,6 +38,7 @@ Package: proxmox-backup-docs Build-Profiles: Section: doc Depends: libjs-extjs, + libjs-mathjax, ${misc:Depends}, Architecture: all Description: Proxmox Backup Documentation diff --git a/debian/proxmox-backup-docs.links b/debian/proxmox-backup-docs.links index 688dfae0..2782f374 100644 --- a/debian/proxmox-backup-docs.links +++ b/debian/proxmox-backup-docs.links @@ -2,3 +2,4 @@ /usr/share/javascript/extjs /usr/share/doc/proxmox-backup/html/prune-simulator/extjs /usr/share/javascript/extjs /usr/share/doc/proxmox-backup/html/lto-barcode/extjs /usr/share/javascript/extjs /usr/share/doc/proxmox-backup/html/api-viewer/extjs +/usr/share/javascript/mathjax /usr/share/doc/proxmox-backup/html/_static/mathjax diff --git a/docs/conf.py b/docs/conf.py index f4e8743a..cfa4158d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -464,3 +464,6 @@ epub_exclude_files = ['search.html'] # If false, no index is generated. # # epub_use_index = True + +# use local mathjax package, symlink comes from debian/proxmox-backup-docs.links +mathjax_path = "mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"