Skip to content

chore(deps): update dependency m2r2 to v2 - #398

Merged
dixonjoel merged 2 commits into
mainfrom
users/renovate/major-python
Oct 12, 2026
Merged

dixonjoel merged 2 commits into
mainfrom
users/renovate/major-python

Conversation

@renovate

@renovate renovate Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

AB#4105793

The m2r2 update caused errors during the ni.panel.v1.proto build. I have included the fix for that build in this chore PR.

Package Change Age Confidence
m2r2 0.3.4 → 2.1.0 age confidence

Release Notes

crossnox/m2r2 (m2r2)

v2.1.0

Compare Source

  • Support Mistune 3.3.

v2.0.0

Compare Source

Breaking changes
  • Replace the Python disable_inline_math argument with inline_math, accepting "legacy", "dollar", or None.
  • Require Mistune 3.2 so footnote rendering shares document definitions.
  • Remove the renderer argument from M2R2. SphinxM2R2 constructs a converter from a docutils document for Sphinx integrations.
  • Make RestRenderer render only the document body when it is used directly with Mistune. M2R2 writes the role and substitution definitions for a complete document.
  • Shorten generated substitution names to a type prefix and twelve hexadecimal hash characters.
  • Discard Markdown link titles, which RST references cannot represent.
  • Resolve fragment links under Sphinx with the m2r-anchor role instead of :ref:.
  • Render links in headings with plain text and anonymous references so section ids stay readable.
  • Start absolute mdinclude paths at the Sphinx source directory instead of the filesystem root.
Fixes and additions
  • Resolve relative Markdown image paths from the included file's directory, including nested includes. Keep image substitutions distinct when different files use the same relative image path.
  • Convert GitHub alerts ([!NOTE], [!TIP], [!IMPORTANT], [!WARNING], and [!CAUTION]) into RST admonitions.
  • Add dollar-delimited inline math with inline_math="dollar", supporting $...$ and dollar-backtick delimiters. Keep "legacy" as the default and use None to disable inline math.
  • Add --inline-math legacy and --inline-math dollar to the CLI. Keep --disable-inline-math to turn off inline math.
  • Add the Sphinx setting m2r_inline_math. Keep m2r_disable_inline_math as a deprecated alias with a warning. An explicit new setting takes precedence.
  • Write document definitions after footnotes render, so links and images in footnotes have their definitions.
  • Preserve emphasis around links and inline markup within link text by using substitutions where RST cannot express the nesting directly.
  • Render empty links as empty references and move footnote references out of link text.
  • Prevent references from nesting inside links. Linked images lose their own targets, and plain link text escapes characters that create RST references.
  • Render strikethrough content as HTML and keep its inline Markdown formatting.
  • Preserve backslashes in text.
  • Derive image alt text from plain text.
  • Resolve same-page and cross-page links to Markdown headings by their GitHub anchors. Resolve explicit RST labels before generated heading anchors with the same name.
  • Add start-after, end-before, lines, literal, code, number-lines, name, and class to mdinclude. Reject its parser option.
  • Track files read by mdinclude so Sphinx rebuilds them when they change.

v1.1.0

Compare Source

  • Add the m2r2.mdinclude Sphinx extension. It provides the mdinclude directive and leaves .md files to another parser.

v1.0.1

Compare Source

  • Keep underscores literal under no_underscore_emphasis with Mistune 3.3's emphasis parser.
  • Keep _ and * inside bare URLs and email addresses from being read as emphasis with Mistune 3.3.
  • Render autolinks through a new standalone_hyperlink renderer method.

v1.0.0

Compare Source

  • Drop support for Python < 3.9.
  • Upgrade to Mistune 3.0+.
  • Rename the converter class to M2R2, retaining M2R as an alias.
  • Deprecate Sphinx config no_underscore_emphasis in favor of m2r_no_underscore_emphasis.
  • Support inline images, including images in table cells, using RST substitutions.
  • Render links and code inside emphasis independently to avoid unsupported nested RST markup.

Configuration

📅 Schedule: (in timezone US/Central)

  • Branch creation
    • Only on Sunday (* * * * 0)
  • Automerge
    • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@github-actions

github-actions Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Test Results

  120 files  ±0    120 suites  ±0   3m 22s ⏱️ -8s
  444 tests ±0    432 ✅ ±0   12 💤 ±0  0 ❌ ±0 
4 440 runs  ±0  4 286 ✅ ±0  154 💤 ±0  0 ❌ ±0 

Results for commit 19f3271. ± Comparison against base commit c1334a6.

♻️ This comment has been updated with latest results.

Signed-off-by: Michael Johansen <michael.johansen@emerson.com>
@renovate

renovate Bot commented Oct 12, 2026

Copy link
Copy Markdown
Contributor Author

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

@dixonjoel
dixonjoel merged commit a9a1936 into main Oct 12, 2026
314 checks passed
@dixonjoel
dixonjoel deleted the users/renovate/major-python branch October 12, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants