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
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 #.
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 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)
Updates the requirements on myst-parser to permit the latest version.
Release notes
Sourced from myst-parser's releases.
Changelog
Sourced from myst-parser's changelog.
... (truncated)
Commits
01c7565🚀 RELEASE v0.19.1 (#735)322cb42🐛 FIX NoURI error in doc reference resolution (#734)585ce9a📚 DOCS: Un-wrap announcement in <p> (#732)8bf2522[pre-commit.ci] pre-commit autoupdate (#653)bcfd1a7📚 Update live preview to myst-docutils 0.19 (#729)de31423🚀 RELEASE v0.19.02cbb184✨ NEW: Addpathandprojectlink schemes022d397📚 DOCS: Full update3e06b80📚 DOCS: Live preview renders themee49b70f🔧 Addmyst-docutils-demoCLIDependabot 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 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)