sdpython · sdpython · Mar 29, 2025 · Oct 8, 2024 · Oct 9, 2024 · Oct 9, 2024
diff --git a/.github/workflows/black-ruff.yml b/.github/workflows/black-ruff.yml
@@ -4,7 +4,7 @@ jobs:
   black-format-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: psf/black@stable
         with:
           options: "--diff --check"

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -21,9 +21,9 @@ jobs:
 
       - uses: tlylt/install-graphviz@v1
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: '3.12'
 
       - name: Install pandoc
         run: sudo apt-get install pandoc
@@ -35,7 +35,7 @@ jobs:
         run: python -m pip install -r requirements-dev.txt
 
       - name: Cache pip
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('requirements-dev.txt') }}
@@ -77,9 +77,9 @@ jobs:
             grep ERROR doc.txt
             exit 1
           fi
-          if [[ $(grep WARNING doc.txt) ]]; then
+          if [[ $(grep WARNING doc.txt | grep -v 'term not in glossary') ]]; then
             echo "Documentation produces warnings."
-            grep WARNING doc.txt
+            grep WARNING doc.txt | grep -v 'term not in glossary'
             exit 1
           fi
 
@@ -96,12 +96,12 @@ jobs:
             grep ERROR doc.txt
             exit 1
           fi
-          if [[ $(grep WARNING doc.txt) ]]; then
+          if [[ $(grep WARNING doc.txt | grep -v 'term not in glossary') ]]; then
             echo "Documentation produces warnings."
-            grep WARNING doc.txt
+            grep WARNING doc.txt | grep -v 'term not in glossary'
             exit 1
           fi
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           path: ./dist/**
diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml
@@ -0,0 +1,24 @@
+name: Spell Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  spell-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Install codespell
+      - name: Install codespell
+        run: pip install codespell
+
+      # Run codespell
+      - name: Run codespell
+        run: codespell --skip="*.png,*.jpg,*.jpeg,*.gif,*.svg,*.ico,*.pdf,*.js,*.css,*.map,./_unittests/ut__main/data/*,./_doc/api/quote.rst,./sphinx_runpython/language.py" --ignore-words-list="nd,te,OT" --check-filenames
diff --git a/.github/workflows/wheels-any.yml b/.github/workflows/wheels-any.yml
@@ -17,13 +17,13 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: '3.12'
 
       - name: build wheel
         run: python -m pip wheel .
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           path: ./sphinx_runpython*.whl
diff --git a/.gitignore b/.gitignore
@@ -19,10 +19,12 @@ _doc/examples/*.html
 _doc/examples/plot_*.png
 _doc/_static/require.js
 _doc/_static/viz.js
+_doc/sg_execution_times.rst
 _unittests/ut__main/*.png
 _unittests/ut__main/data/*.rst
 _unittests/ut__main/data/*.py
 _unittests/ut__main/_cache/*
 _unittests/ut__main/*.html
 _unittests/ut_runpython/*.png
 _unittests/ut_runpython/*.html
+test_latex/*
diff --git a/CHANGELOGS.rst b/CHANGELOGS.rst
@@ -4,6 +4,7 @@ Change Logs
 0.3.0
 +++++
 
+* :pr:`36`: add tools to remove the use of new commands in latex formula
 * :pr:`33`: add simple command line to convert images to pdf
 * :pr:`28`: add syntax to check the readme syntax
 * :pr:`27`: fix missing __text_signature__ in docassert

diff --git a/_doc/api/blocdefs.rst b/_doc/api/blocdefs.rst
@@ -101,22 +101,22 @@ An example:
 ::
 
     .. blocref::
-        :title: How to add a bloc?
-        :tag: bloc
-        :label: l-this-bloc
+        :title: How to add a block?
+        :tag: block
+        :label: l-this-block
 
-        A bloc...
+        A block...
 
 Which gives:
 
 .. blocref::
-    :title: How to add a bloc?
-    :tag: bloc
-    :label: l-this-bloc
+    :title: How to add a block?
+    :tag: block
+    :label: l-this-block
 
-    A bloc...
+    A block...
 
-A reference can be added to this bloc :ref:`Bloc A <l-this-bloc>`.
+A reference can be added to this block :ref:`Block A <l-this-block>`.
 The title needs to be recalled.
 
 mathdef

diff --git a/_doc/api/blocdefs_list.rst b/_doc/api/blocdefs_list.rst
@@ -2,7 +2,7 @@
 blocreflist, exreflist, mathdeflist
 ===================================
 
-These extensions can recall the blocs defined by
+These extensions can recall the blocks defined by
 :ref:`l-blocdefs`.
 
 exreflist
@@ -47,13 +47,13 @@ An example:
 ::
 
     .. blocreflist::
-        :tag: bloc
+        :tag: block
         :contents:
 
 Which gives:
 
 .. blocreflist::
-    :tag: bloc
+    :tag: block
     :contents:
 
 mathdeflist

diff --git a/_doc/api/quote.rst b/_doc/api/quote.rst
@@ -2,7 +2,7 @@
 quote
 =====
 
-A bloc to insert a quote from a book, a film...
+A block to insert a quote from a book, a film...
 
 Usage
 =====

diff --git a/_doc/api/runpython.rst b/_doc/api/runpython.rst
@@ -19,7 +19,7 @@ In *conf.py*:
 Documentation means many examples which needs to be updated when a change
 happen unless the documentation runs the example itself and update its output.
 That's what this directive does. It adds as raw text whatever comes out
-throught the standard output.
+through the standard output.
 
 One example:
 

diff --git a/_doc/api/tools.rst b/_doc/api/tools.rst
@@ -2,7 +2,6 @@
 tools
 =====
 
-
 Checks the readme syntax
 ========================
 
@@ -28,3 +27,10 @@ into examples which can be used into a sphinx gallery.
 ::
 
     python -m sphinx_runpython --help
+
+Tools related to latex
+======================
+
+.. autofunction:: sphinx_runpython.tools.latex_functions.build_regex
+
+.. autofunction:: sphinx_runpython.tools.latex_functions.replace_latex_command
diff --git a/_doc/conf.py b/_doc/conf.py
@@ -1,4 +1,3 @@
-# coding: utf-8
 import os
 import sys
 from sphinx_runpython import __version__
@@ -83,13 +82,16 @@
 nitpick_ignore = [
     ("py:class", "False"),
     ("py:class", "True"),
+    ("py:class", "SphinxPostTransform"),
+    ("py:meth", "Builder.get_relative_uri"),
 ]
 
 nitpick_ignore_regex = [
     ("py:class", ".*numpy[.].*"),
     ("py:func", ".*[.]PyCapsule[.].*"),
     ("py:func", ".*numpy[.].*"),
     ("py:func", ".*scipy[.].*"),
+    ("py:meth", "Builder[.].*"),
 ]
 
 intersphinx_mapping = {

diff --git a/_doc/examples/plot_profiling.py → _doc/examples/plot_profiling_dummy.py b/_doc/examples/plot_profiling.py → _doc/examples/plot_profiling_dummy.py
diff --git a/_unittests/ut__main/data/float_and_double_rouding.ipynb b/_unittests/ut__main/data/float_and_double_rouding.ipynb
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
     quote
     =====
-    A bloc to insert a quote from a book, a film...
+    A block to insert a quote from a book, a film...
     Usage
     =====
@@ Expand Down @@