Skip to content

DOC: render qrules transitions with Mermaid - #586

Merged
redeboer merged 17 commits into
mainfrom
dependabot/lock-8bf9e54cf7
Sep 10, 2026
Merged

redeboer merged 17 commits into
mainfrom
dependabot/lock-8bf9e54cf7

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Sep 9, 2026 •

Copy link
Copy Markdown
Contributor

📝 Documentation

  • The qrules transition graphs in docs/amplitude-analysis.ipynb and docs/amplitude-analysis/analytic-continuation.ipynb are now rendered with qrules.io.asmermaid() and IPython.display.Markdown instead of qrules.io.asdot() and graphviz.Source. Sphinx picks the diagrams up through sphinxcontrib-mermaid with myst_fence_as_directive = ["mermaid"] and nb_render_markdown_format = "myst". A mermaid_init_config and a new docs/_static/mermaid.css keep the diagrams at their natural size and give edge labels a solid background. Graphviz remains a system dependency, because sympy.dotprint() expression trees have no Mermaid equivalent.
  • Display math built with sp.multiline_latex() rendered as Erroneous nesting of equation structures under MathJax 4, which Sphinx 8.2 loads by default: align* and eqnarray may not be nested inside the equation/split wrapper that Sphinx and IPython.display.Math produce. docs/usage.ipynb, docs/usage/binned-fit.ipynb and docs/usage/caching.ipynb now use ampform.io.aslatex(), which renders into the legal aligned environment.
  • The documentation footer no longer names an author.

🖱️ Developer experience

  • The test suite is grouped with pytest-describe: Test* classes and flat test_* functions are replaced by describe_<unit>() blocks whose cases are it_<behavior>() functions, so that a node ID such as tests/data/test_transform.py::describe_SympyDataTransformer::it_caches_the_lambdified_function names both the unit under test and the behavior that broke. Nested describe_* blocks host fixtures that are shared by one group of cases only, which removes set-up that was copy-pasted between test functions.
  • Estimator stubs, the callback mock, and the polynomial minimization cases that test_gradient.py, test_minuit.py and test_scipy.py share are collected in a new tests/optimizer/__init__.py.

🔨 Maintenance

  • docs/conf.py no longer filters the redundant RemovedInSphinx10Warning.

Squash commit messages

* DOC: remove author from documentation footer
* DOC: render multiline equations with ampform.io.aslatex
* DX: define tests with pytest-describe
* MAINT: remove redundant `RemovedInSphinx10Warning`

Bumps the lock group with 6 updates:

| Package | From | To |
| --- | --- | --- |
| [https://github.com/ComPWA/policy](https://github.com/ComPWA/policy) | `0.9.6` | `0.9.7` |
| [https://github.com/astral-sh/ruff-pre-commit](https://github.com/astral-sh/ruff-pre-commit) | `v0.16.5` | `0.16.6` |
| [https://github.com/tombi-toml/tombi-pre-commit](https://github.com/tombi-toml/tombi-pre-commit) | `v1.5.0` | `1.5.2` |
| [https://github.com/streetsidesoftware/cspell-cli](https://github.com/streetsidesoftware/cspell-cli) | `v10.1.0` | `10.2.0` |
| [https://github.com/astral-sh/ty-pre-commit](https://github.com/astral-sh/ty-pre-commit) | `v0.0.77` | `0.0.78` |
| [https://github.com/astral-sh/uv-pre-commit](https://github.com/astral-sh/uv-pre-commit) | `0.12.8` | `0.12.10` |


Updates `https://github.com/ComPWA/policy` from 0.9.6 to 0.9.7
- [Release notes](https://github.com/ComPWA/policy/releases)
- [Commits](ComPWA/policy@0.9.6...0.9.7)

Updates `https://github.com/astral-sh/ruff-pre-commit` from v0.16.5 to 0.16.6
- [Release notes](https://github.com/astral-sh/ruff-pre-commit/releases)
- [Commits](astral-sh/ruff-pre-commit@v0.16.5...v0.16.6)

Updates `https://github.com/tombi-toml/tombi-pre-commit` from v1.5.0 to 1.5.2
- [Release notes](https://github.com/tombi-toml/tombi-pre-commit/releases)
- [Commits](tombi-toml/tombi-pre-commit@v1.5.0...v1.5.2)

Updates `https://github.com/streetsidesoftware/cspell-cli` from v10.1.0 to 10.2.0
- [Release notes](https://github.com/streetsidesoftware/cspell-cli/releases)
- [Changelog](https://github.com/streetsidesoftware/cspell-cli/blob/main/CHANGELOG.md)
- [Commits](streetsidesoftware/cspell-cli@v10.1.0...v10.2.0)

Updates `https://github.com/astral-sh/ty-pre-commit` from v0.0.77 to 0.0.78
- [Release notes](https://github.com/astral-sh/ty-pre-commit/releases)
- [Commits](astral-sh/ty-pre-commit@v0.0.77...v0.0.78)

Updates `https://github.com/astral-sh/uv-pre-commit` from 0.12.8 to 0.12.10
- [Release notes](https://github.com/astral-sh/uv-pre-commit/releases)
- [Commits](astral-sh/uv-pre-commit@0.12.8...0.12.10)

---
updated-dependencies:
- dependency-name: https://github.com/ComPWA/policy
  dependency-version: 0.9.7
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: lock
- dependency-name: https://github.com/astral-sh/ruff-pre-commit
  dependency-version: 0.16.6
  dependency-type: direct:production
  dependency-group: lock
- dependency-name: https://github.com/tombi-toml/tombi-pre-commit
  dependency-version: 1.5.2
  dependency-type: direct:production
  dependency-group: lock
- dependency-name: https://github.com/streetsidesoftware/cspell-cli
  dependency-version: 10.2.0
  dependency-type: direct:production
  dependency-group: lock
- dependency-name: https://github.com/astral-sh/ty-pre-commit
  dependency-version: 0.0.78
  dependency-type: direct:production
  dependency-group: lock
- dependency-name: https://github.com/astral-sh/uv-pre-commit
  dependency-version: 0.12.10
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: lock
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot Bot added the ⬆️ Lock This PR upgrades the lock files label Sep 9, 2026
@redeboer
redeboer marked this pull request as draft September 9, 2026 18:44
@redeboer redeboer added this to the 0.4.18 milestone Sep 9, 2026
@redeboer redeboer changed the title MAINT: bump the lock group with 6 updates DOC: render qrules transitions with Mermaid Sep 9, 2026
@redeboer redeboer added 📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience labels Sep 9, 2026
@redeboer
redeboer self-requested a review September 9, 2026 19:30
@redeboer redeboer added the 🔨 Maintenance Maintenance and upkeep improvements label Sep 10, 2026
@redeboer
redeboer marked this pull request as ready for review September 10, 2026 10:16
@redeboer
redeboer enabled auto-merge (squash) September 10, 2026 10:16
@redeboer redeboer removed the 🔨 Maintenance Maintenance and upkeep improvements label Sep 10, 2026
@redeboer
redeboer merged commit dcfcb70 into main Sep 10, 2026
34 checks passed
@redeboer
redeboer deleted the dependabot/lock-8bf9e54cf7 branch September 10, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience ⬆️ Lock This PR upgrades the lock files

Projects

None yet

2 participants