Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency myst-parser to v3 #120

Closed
wants to merge 1 commit into from
Closed

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 6, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
myst-parser ==0.18.1 -> ==3.0.1 age adoption passing confidence

Release Notes

executablebooks/MyST-Parser (myst-parser)

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.1...v3.0.0

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:

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 😄

v0.19.2

Compare Source

✨ NEW: Add myst_fence_as_directive config (gh-pr:742)

Setting the following config, for example:

extensions = ["myst_parser", "sphinxcontrib.mermaid"]
myst_fence_as_directive = ["mermaid"]

v0.19.1

Compare Source

🐛 FIX NoURI error in doc reference resolution, for texinfo builds (gh-pr:734)

v0.19.0

Compare Source

This release brings a number of exciting new features, improvements, and upgrades 🎉

Full Changelog: v0.18.1...v0.19.0

📚 Rewritten documentation

The documentation has been almost completely rewritten,
with a clearer structure, many more examples, rich hover tips, and a new live preview page ⚡️ (powered by pyscript, gh-pr:717).

The code base API is also now fully documented by sphinx-autodoc2, which even allows for MyST docstrings! (gh-pr:704).

⬆️ Add Sphinx 6 support, drop Sphinx 4

The code base has been updated to support sphinx v6, and is no longer tested against sphinx v4 (gh-pr:664)

📄 Extended docutils (single-page) support

The docutils parser now supports many more features, and improvements to support live previews:

  • myst_suppress_warnings option added, mirroring Sphinx, to suppress MyST warnings (gh-pr:655)
  • myst_meta_html and myst_substitutions options are now supported (gh-pr:672)
  • myst_heading_anchors option is now supported (gh-pr:678)
  • Math block labels syntax is now supported (gh-pr:668)
  • Missing directive/role errors errors are now suppressable warnings (gh-pr:687)
  • Non-fatal directive parsing errors are now suppressable warnings (gh-pr:682)
  • Most of the extended markdown syntax below is also supported
🔗 Extended Markdown links

See the Extended Markdown links section for the full guide.

You can now use standard Markdown link syntax to reference many different types of targets, in a more consistent way.

  • [text](relative/path/myfile.md) work as previously, to link to files,
    but they can also be relative to source directory: [text](/path/from/srcdir/myfile.md).
    You can also use <project:file.md>
  • <path:myfile.txt> will link specifically to a downloadable file
  • [text](#target) or <project:#target> will link (in order of priority) to any local target, local heading anchor, target in the same project, or intersphinx (inventory) target
  • [text](inv:name:domain:type#target) will link specifically to a Sphinx inventory target, or to any inventory <inv:#target>, and can even use * wildcards like <inv:*:*:*#*.target>
    • This can even be used in docutils, with the new myst_inventories config option
    • The myst-inv CLI makes it easy to find the correct inventory target

:::{tip}
It is advised (although not immediately necessary) to prefix all internal references with #.
For example, [...](my-reference), should be changed to [...](#my-reference).
:::

{} Attributes syntax

The attrs_inline and attrs_block extensions allow for common Markdown syntaxes to be extended with greater control over the output.

For example, you can now add classes, ids, and other attributes to inline code, images, and links, as well as to code blocks and directives.

  • Inline code: `a = 1`{#id .class l=python}
  • Images: ![image](image.png){#id .class width=100px}
  • Text spans: [some text]{#id .class}

A paragraph block can have attributes too:

{#id .class}
This is a paragraph with an id and class

A code fence can be given line numbers and line emphasis:

{#id .class lineno-start=1 emphasize-lines="2,3"}
```python
a = 1
b = 2
c = 3
```

A definition list can be turned into a glossary, with referenceable terms:

{.glossary}
term name
: Definition of the term

Quote blocks can be given an attribution:

{attribution="Chris Sewell"}
> My quote
👌 Miscellaneous improvements
  • Nested headings (e.g. inside directives) are now allowed in MyST and are correctly rendered in HTML (gh-pr:711)
  • The colon_fence extension now renders internal content as MyST, rather than as a code block (gh-pr:713)
  • The include directive in MyST documents now supports a :heading-offset: option, to offset the heading levels in the included document
  • The myst_heading_slug_func option now supports setting a str which points to a fully qualified function name, e.g. "module.path.func" (gh-pr:696)
  • The myst_enable_checkboxes option allows for task list checkboxes to be enabled/disabled (gh-pr:686)
Additional contributions
  • 🐛 FIX: Remove unnecessary assert in gh-pr:659, thanks to gh-user:n-peugnet
  • 🔧 ci(deps): setup dependabot (gh-pr:669), thanks to gh-user:mmorel-35
  • 🔧: Depend on typing_extensions only on Python<3.8 in gh-pr:642, thanks to gh-user:hukkin

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 this update again.


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

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the dependencies label May 6, 2024
@renovate renovate bot requested a review from a team May 6, 2024 09:44
Copy link

github-actions bot commented Jun 6, 2024

Stale pull request message. Please comment to remove stale tag. Otherwise this pr will be closed soon.

Copy link
Contributor Author

renovate bot commented Jun 13, 2024

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 3.x releases. But if you manually upgrade to 3.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

@renovate renovate bot deleted the renovate/myst-parser-3.x branch June 13, 2024 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants