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

Bump myst-parser from 0.18.1 to 0.19.0 in /{{cookiecutter.project_slug}}/docs #1016

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 1, 2023

Bumps myst-parser from 0.18.1 to 0.19.0.

Release notes

Sourced from myst-parser's releases.

v0.19.0

This release brings a number of exciting new features, improvements, and upgrades 🎉 https://myst-parser.readthedocs.io

  • 📚 Rewritten documentation, with a clearer structure, many more examples, rich hover tips, and a new live preview page (powered by pyscript)
  • ⬆️ Add Sphinx 6 support
  • 📄 Extended docutils (single-page) support
  • 🔗 Extended Markdown links, including intersphinx support, e.g. [text](https://github.com/executablebooks/MyST-Parser/blob/HEAD/inv:name#target)
  • {} New attributes syntax, to extend common Markdown syntaxes, e.g. ![image](https://github.com/executablebooks/MyST-Parser/blob/HEAD/image.png){#id .class width=100px}

For a full list of changes, see: https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md

Happy parsing! 🤖 Executable books team

Changelog

Sourced from myst-parser's changelog.

0.19.0 - 2023-03-01

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](https://github.com/executablebooks/MyST-Parser/blob/master/relative/path/myfile.md) work as previously, to link to files, but they can also be relative to source directory: [text](https://github.com/executablebooks/MyST-Parser/blob/master/path/from/srcdir/myfile.md). You can also use <project:file.md>
  • <path:myfile.txt> will link specifically to a downloadable file
  • [text](https://github.com/executablebooks/MyST-Parser/blob/master/#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](https://github.com/executablebooks/MyST-Parser/blob/master/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, [...](https://github.com/executablebooks/MyST-Parser/blob/master/my-reference), should be changed to [...](https://github.com/executablebooks/MyST-Parser/blob/master/#my-reference). :::

{} Attributes syntax

... (truncated)

Commits
  • de31423 🚀 RELEASE v0.19.0
  • 2cbb184 ✨ NEW: Add path and project link schemes
  • 022d397 📚 DOCS: Full update
  • 3e06b80 📚 DOCS: Live preview renders theme
  • e49b70f 🔧 Add myst-docutils-demo CLI
  • 37a830d 👌 Add heading-offset option to include directive
  • de00c89 👌 Improve rendering of implicit link text
  • f791cea 🔧 Minor update
  • 1bd0def 🔧 topmatter -> frontmatter
  • 7692f87 ✨ New: add .glossary for attrs_block (#719)
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot will merge this PR once CI passes on it, as requested by @TeoZosa.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Mar 1, 2023
Bumps [myst-parser](https://github.com/executablebooks/MyST-Parser) from 0.18.1 to 0.19.0.
- [Release notes](https://github.com/executablebooks/MyST-Parser/releases)
- [Changelog](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md)
- [Commits](executablebooks/MyST-Parser@v0.18.1...v0.19.0)

---
updated-dependencies:
- dependency-name: myst-parser
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/pip/{{cookiecutter.project_slug}}/docs/myst-parser-0.19.0 branch from d4daefe to b44f697 Compare March 1, 2023 15:17
Copy link
Owner

@TeoZosa TeoZosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dependabot merge

Copy link
Owner

@TeoZosa TeoZosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dependabot merge

@dependabot dependabot bot merged commit bd93cbf into master Mar 1, 2023
@dependabot dependabot bot deleted the dependabot/pip/{{cookiecutter.project_slug}}/docs/myst-parser-0.19.0 branch March 1, 2023 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant