Add custom fonts directly to Matplotlib

This removes the need to manually install them system- or user-wide.

Author: QuLogic

.github/workflows/main.yaml

@@ -55,8 +55,6 @@ jobs:
           sudo sed -i '/disable ghostscript format types/,+6d' /etc/ImageMagick-6/policy.xml
           #
           make -C fonts/
-          cp -r fonts/ /usr/share/fonts/
-          fc-cache
           make all
       - name: Run checks
         run: |

.gitignore

@@ -16,6 +16,7 @@ handout-*.png
 # ----------------------------------
 figures/*.pdf
 fonts/**/*.[ot]tf
+scripts/__pycache__/
 
 # html build
 docs/_build/*

Makefile

@@ -1,4 +1,5 @@
 SRC := $(wildcard *.tex)
+SCRIPTS := $(filter-out _%, $(notdir $(wildcard scripts/*.py)))
 CONVERTFLAGS = -density 150 -alpha remove -depth 8
 
 .PHONY: default
@@ -10,7 +11,7 @@ all: figures cheatsheets handouts docs
 .PHONY: figures
 figures:
 	# generate the figures
-	cd scripts && for script in *.py; do echo $$script; MPLBACKEND="agg" python $$script; done
+	cd scripts && for script in $(SCRIPTS); do echo $$script; MPLBACKEND="agg" python $$script; done
 	# crop some of the figures
 	cd figures && pdfcrop adjustments.pdf adjustments.pdf
 	cd figures && pdfcrop annotate.pdf annotate.pdf

README.md

@@ -15,7 +15,7 @@ Beginner handout [(download pdf)](https://matplotlib.org/cheatsheets/handout-beg
 
 ## How to compile
 
-1. You need to create a `fonts` repository with:
+1. You need to fill the `fonts` directory with:
 
 * `fonts/roboto/*`           : See https://fonts.google.com/specimen/Roboto
                                 or https://github.com/googlefonts/roboto/tree/master/src/hinted
@@ -34,17 +34,6 @@ On Linux, with `make` installed, the fonts can be set up with the following comm
 make -C fonts
 ```
 
-The fonts can be made discoverable by `matplotlib` (through `fontconfig`) by creating the following in `$HOME/.config/fontconfig/fonts.conf` (see [here](https://www.freedesktop.org/software/fontconfig/fontconfig-user.html)):
-
-```xml
-<?xml version="1.0"?>
-<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
-<fontconfig>
-<dir>/path/to/cheatsheets/fonts/</dir>
-...
-</fontconfig>
-```
-
 
 2. You need to generate all the figures:
 

scripts/_custom_fonts.py

@@ -0,0 +1,9 @@
+from pathlib import Path
+
+from matplotlib.font_manager import fontManager
+
+
+def setup():
+    root_dir = Path(__file__).parent.parent.resolve()
+    for font in root_dir.glob('fonts/*/*.[ot]tf'):
+        fontManager.addfont(font)

scripts/adjustements.py

@@ -10,9 +10,12 @@
 import matplotlib.patches as mpatches
 from matplotlib.collections import PatchCollection
 
+import _custom_fonts
+
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
 
+_custom_fonts.setup()
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',
 ])

scripts/advanced-plots.py

@@ -10,9 +10,12 @@
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 
+import _custom_fonts
+
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
 
+_custom_fonts.setup()
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',
     ROOT_DIR / 'styles/plotlet.mplstyle',

scripts/anatomy.py

@@ -10,9 +10,12 @@
 import matplotlib.pyplot as plt
 from matplotlib.ticker import AutoMinorLocator, MultipleLocator, FuncFormatter
 
+import _custom_fonts
+
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
 
+_custom_fonts.setup()
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',
 ])

scripts/annotate.py

@@ -8,8 +8,11 @@
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 
+import _custom_fonts
+
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+_custom_fonts.setup()
 
 fig = plt.figure(figsize=(6, 1))
 # ax = plt.subplot(111, frameon=False, aspect=.1)

scripts/annotation-arrow-styles.py

@@ -3,8 +3,11 @@
 import matplotlib.pyplot as plt
 import matplotlib.patches as mpatches
 
+import _custom_fonts
+
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+_custom_fonts.setup()
 
 styles = mpatches.ArrowStyle.get_styles()