Update docs to v4 (major)

[renovate]

This PR contains the following updates:

Package	Type	Update	Change	Age	Adoption	Passing	Confidence
myst-parser	dependencies	major	>=0.19.1 -> >=4.0.1
myst_parser		major	>=0.19.2 -> >=4.0.1

---

Release Notes

ExecutableBookProject/MyST-Parser (myst-parser)

v4.0.1

🔧 Minor fix for Sphinx 8.2 compatibility (in gh-pr:1013)

v4.0.0

This release bumps the supported versions of:

• Python to 3.10 and greater
• Sphinx to >=7,<9
• Docutils to >=0.19,<0.22

Additionally, footnotes are now parsed similar to the corresponding reStructuredText, in that resolution (between definitions and references) and ordering is now deferred to transforms on the doctree (in gh-pr:931).

This allows for the proper interaction with other docutils/sphinx transforms, including those that perform translations,
and logging of warnings for duplicate/unreferenced footnote definitions and also for footnote references with no definitions.

See the footnotes guide for more information.

Full Changelog: v3.0.1...v4.0.0

v3.0.1

🐛 Bug Fixes

• Account for the final directive option having an empty value, by gh-user:chrisjsewell in gh-pr:924
• Re-allow indented directive option blocks, by gh-user:chrisjsewell in gh-pr:925

Full Changelog: v3.0.0...v3.0.1

v3.0.0

Upgraded dependencies

• ⬆️ Add support for Python 3.12 by gh-user:hugovk in gh-pr:848
• ⬆️ Update docutils requirement from >=0.16,<0.21 to >=0.18,<0.22 by gh-user:chrisjsewell in gh-pr:916

New features

• ✨ Allow for use of the line-block directive by gh-user:chrisjsewell in gh-pr:900
• ✨ Emits sphinx include-read event by gh-user:sumezulike in gh-pr:887

Improvements

• 👌 Nested parse attribution in attr_block by gh-user:chrisjsewell in gh-pr:831
• 👌 Directive option parsing by gh-user:chrisjsewell in <gh-pr:796
• 👌 Improve directive parsing warnings by gh-user:chrisjsewell in gh-pr:893
• 👌 Allow for opening external links in new tabs (#​856) by gh-user:marjus45 in gh-pr:857

Internal

• 🔧 Replace black, isort, pyupgrade with ruff formatter by gh-user:chrisjsewell in gh-pr:833
• 🔧 remove redundant mypy config by gh-user:danieleades in gh-pr:866
• 🔧 Add additional Ruff lints (and fix issues) by gh-user:danieleades in gh-pr:862
• 🔧 mypy- disallow 'any generics' by gh-user:danieleades in gh-pr:865
• 🔧 Fix docutils deprecation in option parsing by gh-user:agoose77 in gh-pr:842

Documentation

• 📚 Fix a broken link in configuration.md by gh-user:zupo in gh-pr:907
• 📚 Add linkify dependency to contributing docs. by gh-user:jhcole in gh-pr:792
• 📚 Fix the double used in docs/syntax/math.md by gh-user:ice-tong in gh-pr:810
• 📚 Also add linkify to pip install command in README by gh-user:n-peugnet in gh-pr:851
• 📚 Fix the code section title in live preview by gh-user:BoboTiG in gh-pr:875
• 📚 Fix admonition example by gh-user:72757373656c6c in gh-pr:904
• 📚 Fix url for jupyter book gallery by gh-user:72757373656c6c in gh-pr:905
• 📚 Update theme version by gh-user:chrisjsewell in gh-pr:918
• 📚 Fix typo by gh-user:blakeNaccarato in gh-pr:911
• 📚 Fix architecture typo (#​855) by gh-user:72757373656c6c in gh-pr:910

Full Changelog: v2.0.0...v3.0.0

v2.0.0

This release primarily updates core myst-parser dependencies,
with some minor changes to parsing behaviour:

• ⬆️ UPGRADE: markdown-it-py to v3 (gh-pr:773)

  • This is mainly a non-breaking change, fixing some edge cases in parsing
  • See: https://github.com/executablebooks/markdown-it-py/releases/tag/v3.0.0
    and https://github.com/executablebooks/mdit-py-plugins/releases/tag/v0.4.0

• ⬆️ UPGRADE: linkify-it-py to v2 (gh-pr:675)

  • Also fixes some edge cases in parsing
  • See: https://github.com/tsutsu3/linkify-it-py/blob/main/CHANGELOG.md

• ⬆️ UPGRADE: Add support for docutils v0.20 (gh-pr:775)

  • No significant changes, see https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04

• ⬆️ UPGRADE: Add support for sphinx v7, and remove v5 support (gh-pr:776)

  • No significant changes, see https://www.sphinx-doc.org/en/master/changes/index.html

• ⬆️ UPGRADE: Remove Python 3.7 support and add testing for Python 3.11 (gh-pr:772)

• 👌 Improve default slug generation for heading anchors, thanks to gh-user:Cimbali (gh-pr:777)

  • This change makes the slug generation closer to GitHub, in that, starting/ending whitespace will not be stripped.
    For example, # ` a` b `c ` will now correctly create the slug -a-b-c- and not a-b-c

• 👌 IMPROVE: Substitution extension (gh-pr:777)

  • Allow any value type (including dict, list, datetime) and emit a myst.substitution warning for errors in resolving the substitution content.

• 🧪 Introduce a gate/check GHA job, thanks to gh-user:webknjaz (gh-pr:635)

Full Changelog: v1.0.0...v2.0.0

v1.0.0

🎉 MyST-Parser 1.0.0 🎉

This changes absolutely nothing in the code, or about the maintenance/release policy of this project.
But it does feel about time 😄

executablebooks/MyST-Parser (myst_parser)

v4.0.1

Compare Source

🔧 Minor fix for Sphinx 8.2 compatibility (in gh-pr:1013)

v4.0.0

Compare Source

This release bumps the supported versions of:

• Python to 3.10 and greater
• Sphinx to >=7,<9
• Docutils to >=0.19,<0.22

Additionally, footnotes are now parsed similar to the corresponding reStructuredText, in that resolution (between definitions and references) and ordering is now deferred to transforms on the doctree (in gh-pr:931).

This allows for the proper interaction with other docutils/sphinx transforms, including those that perform translations,
and logging of warnings for duplicate/unreferenced footnote definitions and also for footnote references with no definitions.

See the footnotes guide for more information.

Full Changelog: v3.0.1...v4.0.0

v3.0.1

Compare Source

🐛 Bug Fixes

• Account for the final directive option having an empty value, by gh-user:chrisjsewell in gh-pr:924
• Re-allow indented directive option blocks, by gh-user:chrisjsewell in gh-pr:925

Full Changelog: v3.0.0...v3.0.1

v3.0.0

Compare Source

Upgraded dependencies

• ⬆️ Add support for Python 3.12 by gh-user:hugovk in gh-pr:848
• ⬆️ Update docutils requirement from >=0.16,<0.21 to >=0.18,<0.22 by gh-user:chrisjsewell in gh-pr:916

New features

• ✨ Allow for use of the line-block directive by gh-user:chrisjsewell in gh-pr:900
• ✨ Emits sphinx include-read event by gh-user:sumezulike in gh-pr:887

Improvements

• 👌 Nested parse attribution in attr_block by gh-user:chrisjsewell in gh-pr:831
• 👌 Directive option parsing by gh-user:chrisjsewell in <gh-pr:796
• 👌 Improve directive parsing warnings by gh-user:chrisjsewell in gh-pr:893
• 👌 Allow for opening external links in new tabs (#​856) by gh-user:marjus45 in gh-pr:857

Internal

• 🔧 Replace black, isort, pyupgrade with ruff formatter by gh-user:chrisjsewell in gh-pr:833
• 🔧 remove redundant mypy config by gh-user:danieleades in gh-pr:866
• 🔧 Add additional Ruff lints (and fix issues) by gh-user:danieleades in gh-pr:862
• 🔧 mypy- disallow 'any generics' by gh-user:danieleades in gh-pr:865
• 🔧 Fix docutils deprecation in option parsing by gh-user:agoose77 in gh-pr:842

Documentation

• 📚 Fix a broken link in configuration.md by gh-user:zupo in gh-pr:907
• 📚 Add linkify dependency to contributing docs. by gh-user:jhcole in gh-pr:792
• 📚 Fix the double used in docs/syntax/math.md by gh-user:ice-tong in gh-pr:810
• 📚 Also add linkify to pip install command in README by gh-user:n-peugnet in gh-pr:851
• 📚 Fix the code section title in live preview by gh-user:BoboTiG in gh-pr:875
• 📚 Fix admonition example by gh-user:72757373656c6c in gh-pr:904
• 📚 Fix url for jupyter book gallery by gh-user:72757373656c6c in gh-pr:905
• 📚 Update theme version by gh-user:chrisjsewell in gh-pr:918
• 📚 Fix typo by gh-user:blakeNaccarato in gh-pr:911
• 📚 Fix architecture typo (#​855) by gh-user:72757373656c6c in gh-pr:910

Full Changelog: v2.0.0...v3.0.0

v2.0.0

Compare Source

This release primarily updates core myst-parser dependencies,
with some minor changes to parsing behaviour:

• ⬆️ UPGRADE: markdown-it-py to v3 (gh-pr:773)

  • This is mainly a non-breaking change, fixing some edge cases in parsing
  • See: https://github.com/executablebooks/markdown-it-py/releases/tag/v3.0.0
    and https://github.com/executablebooks/mdit-py-plugins/releases/tag/v0.4.0

• ⬆️ UPGRADE: linkify-it-py to v2 (gh-pr:675)

  • Also fixes some edge cases in parsing
  • See: https://github.com/tsutsu3/linkify-it-py/blob/main/CHANGELOG.md

• ⬆️ UPGRADE: Add support for docutils v0.20 (gh-pr:775)

  • No significant changes, see https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04

• ⬆️ UPGRADE: Add support for sphinx v7, and remove v5 support (gh-pr:776)

  • No significant changes, see https://www.sphinx-doc.org/en/master/changes/index.html

• ⬆️ UPGRADE: Remove Python 3.7 support and add testing for Python 3.11 (gh-pr:772)

• 👌 Improve default slug generation for heading anchors, thanks to gh-user:Cimbali (gh-pr:777)

  • This change makes the slug generation closer to GitHub, in that, starting/ending whitespace will not be stripped.
    For example, # ` a` b `c ` will now correctly create the slug -a-b-c- and not a-b-c

• 👌 IMPROVE: Substitution extension (gh-pr:777)

  • Allow any value type (including dict, list, datetime) and emit a myst.substitution warning for errors in resolving the substitution content.

• 🧪 Introduce a gate/check GHA job, thanks to gh-user:webknjaz (gh-pr:635)

Full Changelog: v1.0.0...v2.0.0

v1.0.0

Compare Source

🎉 MyST-Parser 1.0.0 🎉

This changes absolutely nothing in the code, or about the maintenance/release policy of this project.
But it does feel about time 😄

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 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 these updates again.

---

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

---

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