Package fonts with niceplots (#43)

* Package fonts with niceplots

* Add fonts on import

* Don't need to install fonts in GHA

* `black -l 120 .`

* update actions/upload-artifact

* Remove font installation from docs build

* Fix `plot_opt_prob`

* Make plot_opt_prob work for old and new matplotlib versions

* Make doc requirements consistent with what we test against

* Don't need custom scraper any more

* Maybe we do

* Update readme

* typo

Author: A-CGray

.github/workflows/niceplots.yml

@@ -32,19 +32,11 @@ jobs:
       - name: Install apt dependencies
         uses: awalsh128/cache-apt-pkgs-action@latest
         with:
-          packages: fonts-cmu nodejs npm
+          packages: nodejs npm
           version: 1.0
       - name: Install node dependencies
         run: |
           sudo npm install -g odiff-bin
-      - name: Install Prompt font
-        run: |
-          mkdir Prompt
-          cd Prompt
-          wget "https://fonts.google.com/download?family=Prompt" -O Prompt.zip
-          unzip Prompt.zip
-          mkdir ~/.fonts
-          cp *.ttf ~/.fonts
       - name: Install python dependencies
         run: |
           pip install --upgrade pip wheel
@@ -61,7 +53,7 @@ jobs:
           cd examples
           bash ImageComparisonTest.sh
       - name: Upload examples if failed
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: ${{ failure() && matrix.python-version == '3.11' && matrix.numpy-version == '1.26.*' && matrix.mpl-version == '3.8.*' }}
         with:
           name: Examples

.readthedocs.yaml

@@ -10,18 +10,6 @@ build:
   os: ubuntu-20.04
   tools:
     python: "3.10"
-  apt_packages:
-    - fonts-cmu
-  # Install the fonts for the james style
-  jobs:
-    pre_install:
-      - mkdir Prompt
-      - cd Prompt
-      - wget "https://fonts.google.com/download?family=Prompt" -O Prompt.zip
-      - unzip Prompt.zip
-      - mkdir ~/.fonts
-      - cp *.ttf ~/.fonts
-      - cd ..
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

README.md

@@ -2,45 +2,13 @@
 from glob import glob
 import shutil
 import os
+import sys
 from sphinx_gallery.scrapers import figure_rst
 from pathlib import PurePosixPath
 
-
-class svgScraper(object):
-    """This is a custom scraper for sphinx-gallery that allows us to use the svg files written by our examples. It is
-    almost entirely copied from the PNGScraper shown at:
-    https://sphinx-gallery.github.io/dev/advanced.html#example-2-detecting-image-files-on-disk
-    """
-
-    def __init__(self):
-        self.seen = set()
-
-    def __repr__(self):
-        return "svgScraper"
-
-    def __call__(self, block, block_vars, gallery_conf):
-        # Find all svg files in the directory of this example.
-        path_current_example = os.path.dirname(block_vars["src_file"])
-        svgs = sorted(glob(os.path.join(path_current_example, "*.svg")))
-
-        # Get the name of the current example, e.g if the file is called "plot_nested_pie_chart.py",
-        # then example_name = "nested_pie_chart"
-        example_name = os.path.splitext(os.path.basename(block_vars["src_file"]))[0].split("plot_")[0]
-
-        # Iterate through svgs, copy them to the sphinx-gallery output directory
-        image_names = list()
-        image_path_iterator = block_vars["image_path_iterator"]
-        for svg in svgs:
-            if svg not in self.seen and example_name.lower() in svg.lower():
-                self.seen |= set(svg)
-                this_image_path = image_path_iterator.next()
-                image_path = PurePosixPath(this_image_path)
-                image_path = image_path.with_suffix(".svg")
-                image_names.append(image_path)
-                shutil.move(svg, image_path)
-        # Use the `figure_rst` helper function to generate rST for image files
-        return figure_rst(image_names, gallery_conf["src_dir"])
-
+# This is necessary for sphinx_gallery to be able to import sphinxext.matplotlib_svg_scraper
+# (see https://sphinx-gallery.github.io/stable/configuration.html#importing-callables)
+sys.path.insert(0, os.path.dirname(__file__))
 
 # -- Project information -----------------------------------------------------
 project = "niceplots"
@@ -50,5 +18,5 @@ def __call__(self, block, block_vars, gallery_conf):
 sphinx_gallery_conf = {
     "examples_dirs": "../examples",  # path to your example scripts
     "gallery_dirs": "auto_examples",  # path to where to save gallery generated output
-    "image_scrapers": (svgScraper(),),
+    "image_scrapers": ("sphinxext.matplotlib_svg_scraper",),
 }

doc/conf.py

@@ -1,3 +1,3 @@
 sphinx_mdolab_theme
 sphinx-gallery
-matplotlib>=3.6
+matplotlib>=3.6,<=3.8

doc/requirements.txt

@@ -0,0 +1,8 @@
+# For some reason, this is needed to make sphinx gallery use the svg files generated by our examples
+# See https://sphinx-gallery.github.io/stable/advanced.html#example-3-matplotlib-with-svg-format for more details
+
+from sphinx_gallery.scrapers import matplotlib_scraper
+
+
+def matplotlib_svg_scraper(*args, **kwargs):
+    return matplotlib_scraper(*args, format="svg", **kwargs)

doc/sphinxext.py

@@ -3,6 +3,7 @@
 =========
 An example of a bar chart.
 """
+
 import matplotlib.pyplot as plt
 import niceplots
 

examples/plot_bar_chart.py

@@ -3,6 +3,7 @@
 ================
 An example of a nested pie chart.
 """
+
 import matplotlib.pyplot as plt
 import niceplots
 

examples/plot_nested_pie_chart.py

@@ -1,4 +1,18 @@
+import os
+from matplotlib import font_manager
+
 __version__ = "2.5.1"
 
+
+def addFonts():
+    font_dirs = [os.path.join(os.path.dirname(__file__), "fonts")]
+    font_files = font_manager.findSystemFonts(fontpaths=font_dirs)
+
+    for font_file in font_files:
+        font_manager.fontManager.addfont(font_file)
+
+
+addFonts()
+
 from .utils import *
 from .parula import *

niceplots/__init__.py

@@ -0,0 +1,93 @@
+Copyright (c) 2015, Cadson Demak ([email protected])
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.