Merge branch 'release/3.1.0.0'

Author: chdemko

.github/workflows/python-package.yml

@@ -23,7 +23,9 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Hatch
-      run: pipx install hatch
+      run: |
+        pipx install hatch
+        pipx inject --force hatch hatchling==1.25.0
     - name: Install dependencies
       run: |
         wget https://github.com/jgm/pandoc/releases/download/${{ matrix.pandoc-version }}/pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
@@ -38,15 +40,17 @@ jobs:
     strategy:
       matrix:
         python-version: ['3.12']
-        pandoc-version: [2.11.4, '2.12', '2.13', 2.14.2, '2.15', 2.16.2, 2.17.1.1, '2.18', 2.19.2, 3.0.1, 3.1.13, 3.2.1, '3.3', '3.4', '3.5']
+        pandoc-version: [3.2.1, '3.3', '3.4', '3.5']
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Hatch
-      run: pipx install hatch
+      run: |
+        pipx install hatch
+        pipx inject --force hatch hatchling==1.25.0
     - name: Install dependencies
       run: |
         wget https://github.com/jgm/pandoc/releases/download/${{ matrix.pandoc-version }}/pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
@@ -69,7 +73,9 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Hatch
-      run: pipx install hatch
+      run: |
+        pipx install hatch
+        pipx inject --force hatch hatchling==1.25.0
     - name: Install dependencies
       run: |
         wget https://github.com/jgm/pandoc/releases/download/${{ matrix.pandoc-version }}/pandoc-${{ matrix.pandoc-version }}-1-amd64.deb
@@ -95,7 +101,9 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Hatch
-      run: pipx install hatch
+      run: |
+        pipx install hatch
+        pipx inject --force hatch hatchling==1.25.0
     - name: Install dependencies
       run: |
         wget https://github.com/jgm/pandoc/releases/download/${{ matrix.pandoc-version }}/pandoc-${{ matrix.pandoc-version }}-1-amd64.deb

.github/workflows/python-publish.yml

@@ -22,7 +22,9 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Hatch
-      run: pipx install hatch
+      run: |
+        pipx install hatch
+        pipx inject --force hatch hatchling==1.25.0
     - name: Build and publish
       env:
         HATCH_INDEX_USER: ${{ secrets.PYPI_USERNAME }}

.readthedocs.yml

@@ -11,6 +11,7 @@ build:
     python: '3.11'
   commands:
   - git fetch --unshallow || true
+  - pip install hatchling==1.25.0
   - pip install hatch
   - hatch run docs:build $READTHEDOCS_OUTPUT/html/
 

README.md

@@ -16,7 +16,7 @@ Installation
 [![Downloads](https://img.shields.io/pypi/dm/pandoc-latex-tip?logo=pypi&logoColor=white)](https://pepy.tech/project/pandoc-latex-tip)
 [![Development Status](https://img.shields.io/pypi/status/pandoc-latex-tip.svg?logo=pypi&logoColor=white)](https://pypi.org/project/pandoc-numbering/)
 [![Python version](https://img.shields.io/pypi/pyversions/pandoc-latex-tip.svg?logo=Python&logoColor=white)](https://pypi.org/project/pandoc-latex-tip/)
-[![Pandoc version](https://img.shields.io/badge/pandoc-2.11%20|%202.12%20|%202.13%20|%202.14%20|%202.15%20|%202.16%20|%202.17%20|%202.18%20|%202.19%20|%203.0%20|%203.1%20|%203.2%20|%203.3%20|%203.4%20|%203.5-blue.svg?logo=markdown)](https://pandoc.org/)
+[![Pandoc version](https://img.shields.io/badge/pandoc-3.2%20|%203.3%20|%203.4%20|%203.5-blue.svg?logo=markdown)](https://pandoc.org/)
 [![Latest release](https://img.shields.io/github/release-date/chdemko/pandoc-latex-tip.svg?logo=github)](https://github.com/chdemko/pandoc-latex-tip/releases)
 [![Last commit](https://img.shields.io/github/last-commit/chdemko/pandoc-latex-tip/develop?logo=github)](https://github.com/chdemko/pandoc-latex-tip/commit/develop/)
 [![Repo Size](https://img.shields.io/github/repo-size/chdemko/pandoc-latex-tip.svg?logo=github)](http://pandoc-latex-tip.readthedocs.io/en/latest/)

docs/conf.py

@@ -15,6 +15,7 @@
 import os
 import sys
 
+# noinspection PyCompatibility
 import tomllib
 
 sys.path.insert(0, os.path.abspath("../.."))

docs/images/Tux.pdf

@@ -7,6 +7,7 @@ pandoc-latex-tip:
     - name: fa-warning
       color: firebrick
       link: 'http://google.fr'
+    - image: Tux.pdf
     position: outer
   - classes: [tip, discussion]
     icons:
@@ -102,6 +103,20 @@ fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident,
 sunt in culpa qui officia deserunt mollit anim id est laborum.
 :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
 
+::: {
+  latex-tip-image=Tux.pdf
+  latex-tip-size=36
+  latex-tip-position=right
+} :::
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
+fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident,
+sunt in culpa qui officia deserunt mollit anim id est laborum.
+:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
 incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
 quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo

docs/images/pandoc-latex-tip-sample.pdf

@@ -61,7 +61,8 @@ Each icon is either:
    `icons <https://fontawesome.com/search?o=r&m=free&f=brands>`__)
 -  a YAML object containing
 
-   -  a ``name`` property (for the icon)
+   -  a ``name`` property (for the icon) or an ``image`` property denoting
+      an image path
    -  a ``color`` property taken from the `X11 color
       collection <https://www.w3.org/TR/css3-color/#svg-color>`__
    -  a ``link`` property to make the icon clickable
@@ -74,6 +75,7 @@ It’s also possible to specify a tip for individual elements using
 attribute description:
 
 -  ``latex-tip-icon``: the name of the icon
+-  ``latex-tip-image``: the file path of the image
 -  ``latex-tip-size``: the size of the rendered icon (``18`` by default)
 -  ``latex-tip-position``: the position of the icon (``left`` by default
    or ``right`` or ``inner`` or ``outer``)
@@ -159,6 +161,10 @@ Demonstration: Using
 as input gives output file in
 `pdf <https://raw.githubusercontent.com/chdemko/pandoc-latex-tip/develop/docs/images/pandoc-latex-tip-sample.pdf>`__.
 
+The `Tux` image is made available under the `Creative Commons CC0 1.0 Universal
+Public Domain Dedication <https://creativecommons.org/publicdomain/zero/1.0/deed.en>`__
+(https://commons.wikimedia.org/wiki/File:Tux.svg).
+
 .. code-block:: shell-session
 
     $ pandoc --filter pandoc-latex-tip pandoc-latex-tip-sample.txt \

docs/images/pandoc-latex-tip-sample.txt

@@ -8,8 +8,8 @@ name = "pandoc-latex-tip"
 description = "A pandoc filter for adding icons on specific elements"
 readme = "README.md"
 requires-python = ">=3.10,<3.14"
-license = {text = "BSD-3-Clause"}
-license-files = {paths = ["LICENSE"]}
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
 authors = [{name = "Christophe Demko", email = "chdemko@gmail.com"}]
 maintainers = [{name = "Christophe Demko", email = "chdemko@gmail.com"}]
 keywords = ["pandoc", "filters", "latex", "tip", "Font-Awesome", "icon"]
@@ -43,7 +43,7 @@ dependencies = [
   "fonttools~=4.54",
   "platformdirs~=4.3",
   "PyYAML~=6.0",
-  "tinycss2~=1.3",
+  "tinycss2~=1.4",
   "cleo~=2.1"
 ]
 
@@ -52,6 +52,7 @@ Homepage = "https://github.com/chdemko/pandoc-latex-tip"
 Documentation = "https://pandoc-latex-tip.readthedocs.io/"
 Repository = "https://github.com/chdemko/pandoc-latex-tip"
 Issues = "https://github.com/chdemko/pandoc-latex-tip/issues"
+Coverage = "https://coveralls.io/github/chdemko/pandoc-latex-tip"
 
 [project.scripts]
 pandoc-latex-tip = "pandoc_latex_tip:app"
@@ -80,16 +81,16 @@ dependencies = [
   "black[jupyter]~=24.10",
   # Style checkers
   "doc8~=1.1",
-  "mypy~=1.12",
+  "mypy~=1.13",
   "flake8~=7.1",
   "flake8-pyproject~=1.2",
   "flake8-annotations-complexity~=0.0",
   "flake8-black~=0.3",
   "flake8-blind-except~=0.2",
-  "flake8-bugbear~=24.8",
+  "flake8-bugbear~=24.10",
   "flake8-builtins~=2.5",
   "flake8-cognitive-complexity~=0.1",
-  "flake8-comprehensions~=3.15",
+  "flake8-comprehensions~=3.16",
   "flake8-docstrings~=1.7",
   "flake8-expression-complexity~=0.0",
   "flake8-fixme~=1.1",