sphinx-exercise 1.2.0__tar.gz → 1.2.1__tar.gz

{sphinx_exercise-1.2.0 → sphinx_exercise-1.2.1}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [v1.2.1](https://github.com/executablebooks/sphinx-exercise/tree/v1.2.1) (2025-11-17)
+
+### Fixes 🐛
+
+- Fixed `ValueError: list.remove(x): x not in list` when building LaTeX/PDF output ([#82](https://github.com/executablebooks/sphinx-exercise/pull/82))
+  - Added defensive check before removing 'std-ref' class in `UpdateReferencesToEnumerated` transform
+  - The 'std-ref' class may not be present in all build scenarios (particularly LaTeX/PDF builds)
+  - Fix ensures compatibility across different Sphinx builders and versions
+
 ## [v1.2.0](https://github.com/executablebooks/sphinx-exercise/tree/v1.2.0) (2025-11-05)
 
 ### New ✨

{sphinx_exercise-1.2.0 → sphinx_exercise-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-exercise
-Version: 1.2.0
+Version: 1.2.1
 Summary: A Sphinx extension for producing exercises and solutions.
 Project-URL: Homepage, https://github.com/executablebooks/sphinx-exercise
 Project-URL: Source, https://github.com/executablebooks/sphinx-exercise

{sphinx_exercise-1.2.0 → sphinx_exercise-1.2.1}/docs/source/releases/index.md

@@ -5,6 +5,7 @@ This section contains detailed release notes for sphinx-exercise versions.
 ```{toctree}
 :maxdepth: 1
 
+v1.2.1
 v1.2.0
 v1.1.1
 v1.1.0

sphinx_exercise-1.2.1/docs/source/releases/v1.2.1.md

@@ -0,0 +1,65 @@
+# Release v1.2.1
+
+**Release Date**: November 17, 2025
+
+This is a patch release that fixes a bug causing build failures in LaTeX/PDF output.
+
+## 🐛 Bug Fixes
+
+### LaTeX/PDF Build Failure
+
+Fixed a `ValueError: list.remove(x): x not in list` error that occurred when building LaTeX/PDF documentation with sphinx-exercise v1.2.0.
+
+**Issue:**
+- The `UpdateReferencesToEnumerated` transform attempted to remove the `'std-ref'` CSS class from inline reference nodes
+- In LaTeX/PDF builds (and potentially other build scenarios), this class may not be present
+- Python's `list.remove()` raises a `ValueError` when the item doesn't exist, causing the build to fail
+
+**Fix:**
+- Added a defensive check: `if "std-ref" in classes:` before attempting removal
+- The transform now safely handles cases where the class is absent
+- Preserves the intended behavior: converting textual references to numeric references for enumerated exercises
+
+**Impact:**
+- Fixes build failures in projects using sphinx-exercise with LaTeX/PDF output
+- No functional changes to existing behavior
+- All existing tests continue to pass
+
+**Example Error (before fix):**
+```
+Exception occurred:
+  File ".../sphinx_exercise/post_transforms.py", line 69, in run
+    classes.remove("std-ref")
+ValueError: list.remove(x): x not in list
+```
+
+## 📦 Installation
+
+Install or upgrade via pip:
+
+```bash
+pip install --upgrade sphinx-exercise
+```
+
+## 🔄 Migration Notes
+
+**If you're upgrading from v1.2.0:**
+- No breaking changes
+- No action required
+- If you encountered LaTeX/PDF build failures with v1.2.0, this release fixes that issue
+
+**Compatibility:**
+- Python 3.10, 3.11, 3.12, 3.13
+- Sphinx 6, 7, 8
+- All existing directives and configurations continue to work
+
+## 🔗 Related Issues
+
+- PR [#82](https://github.com/executablebooks/sphinx-exercise/pull/82) - Fix std-ref class removal
+- Issue discovered in [QuantEcon/continuous_time_mcs CI build](https://github.com/QuantEcon/continuous_time_mcs/actions/runs/19413054039/job/55537214078?pr=144)
+
+## 📚 Documentation
+
+For complete documentation, see:
+- [Configuration Options](../syntax.md)
+- [Installation Guide](../install.md)

{sphinx_exercise-1.2.0 → sphinx_exercise-1.2.1}/sphinx_exercise/__init__.py

@@ -7,7 +7,7 @@ This package is an extension for sphinx to support exercise and solutions.
 :license: MIT, see LICENSE for details.
 """
 
-__version__ = "1.2.0"
+__version__ = "1.2.1"
 
 from pathlib import Path
 from typing import Any, Dict, Set, Union, cast

{sphinx_exercise-1.2.0 → sphinx_exercise-1.2.1}/sphinx_exercise/post_transforms.py

@@ -66,7 +66,8 @@ class UpdateReferencesToEnumerated(SphinxPostTransform):
                         # Get Metadata from Inline
                         inline = node.children[0]
                         classes = inline["classes"]
-                        classes.remove("std-ref")
+                        if "std-ref" in classes:
+                            classes.remove("std-ref")
                         classes.append("std-numref")
                         # Construct a Literal Node
                         literal = docutil_nodes.literal()

{sphinx_exercise-1.2.0 → sphinx_exercise-1.2.1}/tests/conftest.py

@@ -99,6 +99,15 @@ class FileRegression:
         (r"ipykernel_\d+", "ipykernel_XXXXX"),
         # Normalize matplotlib image hashes (platform/version dependent)
         (r"[a-f0-9]{64}\.png", "IMAGEHASH.png"),
+        # Strip matplotlib font cache warning (appears in CI on first run)
+        (
+            r'<div class="output stderr highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>Matplotlib is building the font cache; this may take a moment\.\n</pre></div>\n</div>\n',
+            "",
+        ),
+        (
+            r'<literal_block classes="output stderr" language="myst-ansi" xml:space="preserve">\s*Matplotlib is building the font cache; this may take a moment\.\n\s*',
+            "",
+        ),
     )
 
     def __init__(self, file_regression):