DOC: visualize qrules results with Mermaid - #510
Merged
Conversation
Bumps the lock group with 1 update: [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv). Updates `astral-sh/setup-uv` from 7.6.0 to 10.0.1 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](astral-sh/setup-uv@37802ad...20cfd1b) --- updated-dependencies: - dependency-name: astral-sh/setup-uv dependency-version: 10.0.1 dependency-type: direct:production update-type: version-update:semver-major dependency-group: lock ... Signed-off-by: dependabot[bot] <support@github.com>
qrules results with Mermaid
redeboer
self-requested a review
September 2, 2026 20:14
redeboer
force-pushed
the
dependabot/lock-2514a98571
branch
from
September 4, 2026 12:38
24b5af3 to
43294a6
Compare
redeboer
approved these changes
Sep 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Documentation
qrules.io.asmermaid()) and in the docstrings generated bydocs/_extend_docstrings.py(.. mermaid::directives instead of pre-rendered SVGs). The two topologies inget_boost_chain_suffix()are now stacked vertically, so its docstring refers to the top and bottom topology instead of the left and right one./dynamics/k-matrixare replaced with hand-drawn Feynman diagrams (docs/_static/kmatrix-*.svg), with LaTeX labels and anonly-darkvariant each, so they follow the theme of the page./dynamics/customshows the source ofResonanceDynamicsBuilderandcreate_relativistic_breit_wigner()as a folded, syntax-highlighted code block instead of rawprint()output, and the amplitude expressions in {doc}/amplitude/formalismare rendered withaslatex(), so symbol and expression appear as one aligned equation. The formalism comparison table in that same notebook is built as Markdown instead of arichtable, which dropsrichfrom thenotebooksdependency group.qrules.transitionlogger toERROR. Cells that were taggedremove-outputonly to hide that bar now show their output again.code_prompt_showlabel describing the diagram, and the documentation footer no longer shows an author line (author = "").🖱️ Developer experience
.binder/apt.txt, fromci.yml, from the Read the Docspixi global install, and fromtool.compwa.policy.doc-apt-packages. The publicampform[viz]extra is untouched.sphinxcontrib-mermaidis added to thedocdependency group andmyst_fence_as_directiveis enabled, so ```mermaid fences render as diagrams.mermaid_height="auto"plus `docs/_static/mermaid.css` draw diagrams at their natural size instead of stretching them to 500px and give edge labels an opaque background, and `mermaid_init_config` tightens node and rank spacing. The `notebooks` group now requires `qrules >=0.10.12` and no longer pulls in `ampform[viz]`.*.svgfiles are excluded from spell checking.🐛 Bug fixes
eqnarray({doc}/dynamics/k-matrix) oralign({doc}/amplitude/formalism) now usealigned. MathJax 4 refuses to nest these AMS structures inside thesplitthat Sphinx wraps math blocks in and inside the$\displaystyle ... $fromIPython.display.Math, so they rendered as Erroneous nesting of equation structures. For the same reason, the amplitude colors are applied with\textcolorinstead of the unscoped\color. Closes Equations with eqnarray and align render as an error under MathJax 4 #511html_static_pathis restored in the Sphinx configuration andhtml_css_filespoints at the existinglinebreaks-api.cssinstead of a non-existentcustom.css, so the custom stylesheets are actually copied and loaded.scipyintersphinx URL:_get_scipy_url()is dropped in favor of a fixed inventory URL (see Restore the pinned SciPy intersphinx inventory #512), which keepssphinx-buildworking offline.Squash commit messages