matplotlib 3.4 hotfix (#89)

Author: kip-hart

.github/workflows/codeql-analysis.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.

.github/workflows/documentation.yaml

@@ -12,9 +12,10 @@ jobs:
 
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout
+      uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.10'
     - name: Setup Linux Environment
@@ -36,17 +37,26 @@ jobs:
         if [ "${{ matrix.doc-type }}" = html ]; then echo "art_path=docs/build-html" >> $GITHUB_ENV; fi
         if [ "${{ matrix.doc-type }}" = latex ]; then echo "art_path=docs/build-latex/MicroStructPy.pdf" >> $GITHUB_ENV; fi
         if [ "${{ matrix.doc-type }}" = epub ]; then echo "art_path=docs/build-epub/MicroStructPy.epub" >> $GITHUB_ENV; fi
+
+    - name: Build PDF (latex only)
+      if: matrix.doc-type == 'latex'
+      run: |
+        # Update apt
+        sudo apt-get update
         
-        # Build PDF 
-        if [ "${{ matrix.doc-type }}" = latex ]; then sudo apt install texlive-fonts-recommended; fi
-        if [ "${{ matrix.doc-type }}" = latex ]; then sudo apt install texlive-latex-recommended; fi
-        if [ "${{ matrix.doc-type }}" = latex ]; then sudo apt install texlive-lang-english; fi
-        if [ "${{ matrix.doc-type }}" = latex ]; then sudo apt install texlive-xetex; fi
-        if [ "${{ matrix.doc-type }}" = latex ]; then sudo apt install latexmk; fi
-        if [ "${{ matrix.doc-type }}" = latex ]; then cd docs/build-latex; fi
-        if [ "${{ matrix.doc-type }}" = latex ]; then make; fi
-        if [ "${{ matrix.doc-type }}" = latex ]; then cd -; fi
-        
+        # Install LaTeX packages
+        # Recommended by Sphinx on their docs page:
+        # https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.latex.LaTeXBuilder
+        sudo apt install texlive-latex-recommended
+        sudo apt install texlive-fonts-recommended
+        sudo apt install tex-gyre # (if latex_engine left to default)
+        sudo apt install texlive-latex-extra
+        sudo apt install latexmk
+
+        # Make
+        cd docs/build-latex
+        make
+        cd -
         
     - name: Upload artifact
       uses: actions/upload-artifact@v3

.github/workflows/ossar-analysis.yml

@@ -16,7 +16,7 @@ jobs:
     steps:
       # Checkout your code repository to scan
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.

.github/workflows/python_package.yaml

@@ -13,9 +13,9 @@ jobs:
         os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -56,9 +56,9 @@ jobs:
 
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Cache pip

.github/workflows/python_publish.yaml

@@ -17,7 +17,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - name: Install dependencies

.readthedocs.yaml

@@ -0,0 +1,28 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+formats: all
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+  apt_packages:
+    - freeglut3-dev
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+    install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

.readthedocs.yml

@@ -6,6 +6,14 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog`_,
 and this project adheres to `Semantic Versioning`_.
 
+`1.5.7`_ - 2023-08-06
+--------------------------
+Fixed
+'''''''
+- Errors associated with using keyword arguments in ``plt.gca()`` deprecated in matplotlib 3.4.
+- 3D plots now use matplotlib standard for setting equal aspect ratios.
+
+
 `1.5.6`_ - 2022-09-01
 --------------------------
 Fixed
@@ -292,7 +300,8 @@ Added
 
 .. LINKS
 
-.. _`Unreleased`: https://github.com/kip-hart/MicroStructPy/compare/v1.5.6...HEAD
+.. _`Unreleased`: https://github.com/kip-hart/MicroStructPy/compare/v1.5.7...HEAD
+.. _`1.5.7`: https://github.com/kip-hart/MicroStructPy/compare/v1.5.6...v1.5.7
 .. _`1.5.6`: https://github.com/kip-hart/MicroStructPy/compare/v1.5.5...v1.5.6
 .. _`1.5.5`: https://github.com/kip-hart/MicroStructPy/compare/v1.5.4...v1.5.5
 .. _`1.5.4`: https://github.com/kip-hart/MicroStructPy/compare/v1.5.3...v1.5.4

CHANGELOG.rst

@@ -7,7 +7,7 @@ include .bumpversion.cfg
 include .coveragerc
 include .editorconfig
 include .pyup.yml
-include .readthedocs.yml
+include .readthedocs.yaml
 
 include CHANGELOG.rst
 include LICENSE.rst

MANIFEST.in

@@ -1,6 +1,6 @@
-gmsh==4.10.5
-matplotlib==3.5.1
-numpy==1.22.0
+gmsh==4.11.1
+matplotlib==3.7.2
+numpy==1.24.4
 pybind11==2.4.3
 sphinx==4.2.0
 sphinx-gallery==0.8.1