Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==0.17.2→==0.19.2Release Notes
executablebooks/MyST-Parser (myst_parser)
v0.19.2Compare Source
✨ NEW: Add myst_fence_as_directive config (gh-pr:742)
Setting the following config, for example:
v0.19.1Compare Source
🐛 FIX
NoURIerror in doc reference resolution, for texinfo builds (gh-pr:734)v0.19.0Compare 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
docutilsparser now supports many more features, and improvements to support live previews:myst_suppress_warningsoption added, mirroring Sphinx, to suppress MyST warnings (gh-pr:655)myst_meta_htmlandmyst_substitutionsoptions are now supported (gh-pr:672)myst_heading_anchorsoption is now supported (gh-pr:678)🔗 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>myst_inventoriesconfig optionmyst-invCLI 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 syntaxThe
attrs_inlineandattrs_blockextensions 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.
`a = 1`{#id .class l=python}{#id .class width=100px}[some text]{#id .class}A paragraph block can have attributes too:
{#id .class} This is a paragraph with an id and classA 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 termQuote blocks can be given an attribution:
{attribution="Chris Sewell"} > My quote👌 Miscellaneous improvements
colon_fenceextension now renders internal content as MyST, rather than as a code block (gh-pr:713)includedirective in MyST documents now supports a:heading-offset:option, to offset the heading levels in the included documentmyst_heading_slug_funcoption now supports setting astrwhich points to a fully qualified function name, e.g."module.path.func"(gh-pr:696)myst_enable_checkboxesoption allows for task list checkboxes to be enabled/disabled (gh-pr:686)Additional contributions
Python<3.8in gh-pr:642, thanks to gh-user:hukkinv0.18.1Compare Source
Full Changelog: v0.18.0...v0.18.1
attrs_image(experimental) extension in gh-pr:620{#id .class width=100px}v0.18.0Compare Source
Full Changelog: v0.17.2...v0.18.0
This release adds support for Sphinx v5 (dropping v3), restructures the code base into modules, and also restructures the documentation, to make it easier for developers/users to follow.
It also introduces document-level configuration via the Markdown front-matter, under the
mystkey.See the Local configuration section for more information.
Breaking changes
This should not be breaking, for general users of the sphinx extension (with
sphinx>3),but will be for anyone directly using the Python API, mainly just requiring changes in import module paths.
The
to_docutils,to_html,to_tokens(frommyst_parser/main.py) andmock_sphinx_env/parse(frommyst_parser.sphinx_renderer.py) functions have been removed, since these were primarily for internal testing.Instead, for single page builds, users should use the docutils parser API/CLI (see ),
and for testing, functionality has been moved to https://github.com/chrisjsewell/sphinx-pytest.
The top-level
html_metaandsubstitutionsfront-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of themystconfig, e.g.is replaced by:
Key PRs
parse_directive_textwhen body followed by options (gh-pr:580)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.
This PR was generated by Mend Renovate. View the repository job log.