fix(deps): update dependency myst-parser to v5 #56
No reviewers
Labels
No labels
ansible
bug
ci
dependencies
digest
docker
documentation
duplicate
enhancement
fix
go
good first issue
help wanted
invalid
javascript
major
minor
patch
php
python
question
released
security
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
dawid/langchain-memvid!56
Loading…
Reference in a new issue
No description provided.
Delete branch "renovate/myst-parser-5.x"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
==4.0.1→==5.2.0Release Notes
executablebooks/MyST-Parser (myst-parser)
v5.2.0Compare Source
Heading anchors are now stable and documented:
one shared slug implementation with
"github","gitlab"and"docutils"presets,slugs emitted as real HTML ids, explicit
(target)=ids taking priority, and a versioned anchor contract.Warnings and other tools now get accurate source lines (also inside
{include}d files),docutils 0.23 is supported, inputs that used to abort the build now warn instead,
and many fixes land for references, images, front matter, substitutions and directives;
a new
section_refextension links§1.1-style references to numbered headings.Nothing is dropped: Python
>=3.11, Sphinx>=8,<10and the markdown-it-py requirement are unchanged,mdit-py-plugins is raised to
~=0.7(it was~=0.6,>=0.6.1),and the docutils range is widened to
>=0.20,<0.24.Some of these changes can still alter the output of a project that built before, so please read the upgrade notes.
‼️ Upgrade notes
x,x-1,x-2, as on GitHub;the third and later duplicates used to get
x-1-2,x-1-2-3, ...So a link that uses the old slug of a third or later duplicate, such as
[](#x-1-2), no longer resolvesand warns (
myst.xref_missing, which fails a-Wbuild): change it to[](#x-2).Links to the first two duplicates are unchanged, and every HTML id a heading had before is kept.
ids on the rendered headings, so#sluglinks work in the published HTML.The docutils id stays the primary (first) id, so existing fragment links keep working.
Set
myst_heading_anchors_html_ids = Falseto emit only the docutils id.(target)=placed before a heading becomes the section's primary id,which tocs, permalinks and
objects.invuse; the implicit heading id is kept as a secondary anchor."docutils"preset) gets no anchor,and an empty fragment,
[](#), now warns as unresolved.same-document links to implicit ids (such as headings deeper than
myst_heading_anchors; under Sphinx only as a last resort),and cross-document links to label ids and to the implicit ids of headings within the
myst_heading_anchorsdepth.[](doc.md#label)takes the target's title as its text (gh-pr:1207).pinned by a versioned, language-agnostic corpus (
tests/fixtures/slugs.json).myst_parser.mdit_to_docutils.base.default_slugifyis deprecated in favour ofmyst_parser.slugs.github_slugify.and unknown options are reported one per warning, as
Unknown option key: 'x' (allowed: [...]),instead of one aggregate
Unknown option keys: [...].The
myst.directive_optionsubtype is unchanged, sosuppress_warningskeeps working,but tests that match the old message need updating.
block_text, as in reStructuredText,so errors that echo it show the whole fence;
and
content_offsetis-1when the body starts on the opening line.Text nodes no longer take the line of the most recent directive (so gettext
.potlocations change),lines inside
{include}d files are no longer one late,and the body of a directive with options and a trailing blank line is no longer one line off.
(
heading_slug_func,update_mathjax,mathjax_classes,suppress_warnings,inventories)now warn (
myst.topmatter) and are ignored in a document's front matter.This removes the undocumented per-document effect of
inventories(docutils) andupdate_mathjax(Sphinx).parsed-literalkeeps each line's indentation, and two trailing spaces no longer make a hard line break (gh-pr:1176);$$math blocks lose the blank lines at the start and end of their content, which broke LaTeX output (gh-pr:1224);myst_links_external_new_tabwritesrel="noreferrer"(it was misspeltnoreferer),and no longer overwrites an authored
targetorrel(gh-pr:1200);an HTML
<img>keeps its alt text exactly, and a valuelessaltis now empty rather thanNone(gh-pr:1214);python -m build,so the sdists hold only the package,
pyproject.toml,README.mdandLICENSE(no longer
CHANGELOG.md,tox.inior.github/); the wheels are unaffected.mdit-py-plugins>=0.7,<1.✨ New Features
myst_parser.slugs), named presets formyst_heading_slug_func("github","gitlab"), slugs emitted as HTML ids (myst_heading_anchors_html_ids), explicit-id priority, fewer false warnings for working links, andmyst-anchors --slug-func, by gh-user:chrisjsewell in gh-pr:1158"docutils"heading slug preset (byte-identical todocutils.nodes.make_id) and a versioned anchor contract, see , by gh-user:chrisjsewell in gh-pr:1168"section_ref"syntax extension: section-sign references such as§1,§1.1and§2.3.4link to the correspondingly numbered heading of the current document (numbered the same in docutils and Sphinx), with a suppressiblemyst.section_refwarning when no heading matches, see , by gh-user:chrisjsewell in gh-pr:1170👌 Improvements
block_text(superseding gh-pr:1048, thanks to gh-user:kdeldycke), and anincludewith:literal:gets its true line, by gh-user:chrisjsewell in gh-pr:1164{table}caption to wrap onto the following lines, by gh-user:BetterAndBetterII in gh-pr:1195env.metadata[env.docname], by gh-user:holmboe in gh-pr:1171🐛 Bug Fixes
linkifywithoutlinkify-it-pyinstalled is disabled with amyst.linkifywarning instead of crashing, by gh-user:chrisjsewell in gh-pr:1153[](doc.md#label)links to explicit targets in other documents without a falsemyst.xref_missingwarning (gh-issue:1151, reported by gh-user:kdeldycke), using the target's title as the link text, by gh-user:dstrodtman in gh-pr:1207{include}d files (also with:start-after:and a negative:start-line:), by gh-user:chrisjsewell, gh-user:dchaudhari7177, gh-user:vishalkaay and gh-user:Sanjays2402 in gh-pr:1169enable_extensions,fence_as_directive,url_schemes), and rejectglobal_onlyoptions in front matter, by gh-user:dchaudhari7177 in gh-pr:1197html_image), so a newline in an attribute can no longer inject a directive option, by gh-user:AryanRG in gh-pr:1214parsed-literaldirectives, by gh-user:deepakganesh78 in gh-pr:1176{{foo-bar}}, by gh-user:agu2347 in gh-pr:1172{w=…}) or a duplicate heading{#id}, and fix the new-tab link attributes, by gh-user:chrisjsewell in gh-pr:1200$$math blocks, which broke LaTeX output, by gh-user:chrisjsewell in gh-pr:1224setup_sphinxto run twice, somyst_parserandmyst_nbcan both be listed inextensions, by gh-user:chrisjsewell in gh-pr:1222⬆️ Dependency Upgrades
mdit-py-plugins~=0.7, for itssection_refplugin, by gh-user:chrisjsewell in gh-pr:1170docutils>=0.20,<0.24), reported by gh-user:befeleme in gh-issue:1152, by gh-user:chrisjsewell in gh-pr:1157testingextra's pygments requirement from<2.21to<2.22in gh-pr:1191flit_core>=3.4,<5) in gh-pr:1185📚 Documentation
\[...\]and\(...\)math delimiters from the syntax reference, by gh-user:chrisjsewell in gh-pr:1220auto_modein sphinx-autodoc2, by gh-user:nerdoc in gh-pr:1157 (from gh-pr:1032)sphinx-syntax-example, by gh-user:chrisjsewell in gh-pr:1181🔧 Internal / Maintenance
Full Changelog: v5.1.0...v5.2.0
v5.1.0Compare Source
✨ New Features
"alert"syntax extension for GFM alerts (e.g.> [!NOTE]), see by gh-user:chrisjsewell in gh-pr:1128"gfm_autolink"syntax extension for GFM autolinks, see by gh-user:chrisjsewell in gh-pr:1128myst_strikethrough_single_tildeconfig option to allow single tilde (~) for strikethrough by gh-user:chrisjsewell in gh-pr:1128myst_colon_fence_exact_matchconfig option to require the closing colon fence to have exactly the same number of colons as the opening, see by gh-user:chrisjsewell in gh-pr:1128👌 Improvements
myst_gfm_onlymode to use the unifiedgfm_plugin, which now includes GFM autolinks, alerts, and improved strikethrough/tasklist handling by gh-user:chrisjsewell in gh-pr:1128🐛 Bug Fixes
&in Markdown URLs by not HTML-escapingrefuriby gh-user:chrisjsewell in gh-pr:1126RemovedInSphinx10Warningfor inventory item iteration by gh-user:chrisjsewell in gh-pr:1129mdit-py-plugins>=0.6.1for nested field list fix by gh-user:chrisjsewell in gh-pr:1134⬆️ Dependency Upgrades
markdown-it-py~=4.2andmdit-py-plugins~=0.6by gh-user:chrisjsewell in gh-pr:1128<2.20to<2.21by gh-user:chrisjsewell in gh-pr:1117Full Changelog: v5.0.0...v5.1.0
v5.0.0Compare Source
This release significantly bumps the supported versions of core dependencies:
‼️ Breaking Changes
This release updates the minimum supported versions:
>=3.11(dropped Python 3.10, tests up to 3.14)>=8,<10(dropped Sphinx 7, added Sphinx 9)>=0.20,<0.23(dropped docutils 0.19, added docutils 0.22)~=4.0(upgraded from v3)⬆️ Dependency Upgrades
👌 Improvements
📚 Documentation
cross-referencing.mdby gh-user:krassowski in gh-pr:1036🔧 Internal / Maintenance
AGENTS.mdby gh-user:chrisjsewell in gh-pr:1083Full Changelog: v4.0.1...v5.0.0
Configuration
📅 Schedule: (in timezone Europe/Berlin)
* 0-5 * * 1)🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate CLI.
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.Merge
Merge the changes and update on Forgejo.Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.