Permalink
Comparing changes
Choose two branches to see what’s changed or to start a new pull request.
If you need to, you can also or
learn more about diff comparisons.
Open a pull request
Create a new pull request by comparing changes across two branches. If you need to, you can also .
Learn more about diff comparisons here.
...
6
contributors
Commits on Dec 5, 2022
-
-
[pre-commit.ci] pre-commit autoupdate (#625)
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
-
Commits on Jan 4, 2023
-
✨ NEW: Add inventory reader and CLI (#656)
Extracted from sphinx for use independently.
-
-
🐛 FIX: Remove unnecessary assert (#659)
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com> Fixes #657
-
✨ NEW: suppress warnings in docutils (#655)
with `myst_suppress_warnings` option, which works the same as sphinx `suppress_warnings`.
Commits on Jan 5, 2023
-
✨ NEW: Add
attrs_inlineextension (#654)By adding `"attrs_inline"` to `myst_enable_extensions` (in the sphinx `conf.py`), you can enable parsing of inline attributes after certain inline syntaxes. This is adapted from [djot inline attributes](https://htmlpreview.github.io/?https://github.com/jgm/djot/blob/master/doc/syntax.html#inline-attributes), and also related to [pandoc bracketed spans](https://pandoc.org/MANUAL.html#extension-bracketed_spans). This extension replaces `"attrs_image"`, which is still present, but deprecated.
-
-
Commits on Jan 6, 2023
-
👌 Reference attributes title -> reftitle (#666)
Sphinx will output reftitle as the HTML title attr. See: https://github.com/sphinx-doc/sphinx/blob/6e6b9ad45194177811551c77f5f4040213d1c661/sphinx/writers/html5.py#L227
-
-
-
Commits on Jan 8, 2023
-
👌
‼️ Allow meta_html/substitutions in docutils (#672)Refactors `myst_parser/parsers/docutils_.py` slightly, by removing `DOCUTILS_EXCLUDED_ARGS`, and removing the `excluded` argument from `create_myst_settings_spec` and `create_myst_config`.
Commits on Jan 10, 2023
-
-
-
🔧 ci(deps): setup dependabot (#669)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
3 people authoredJan 10, 2023
Commits on Jan 11, 2023
-
👌 IMPROVE: Allow for heading anchor links in docutils (#678)
This aligns the treatment of `[](#target)` style links for docutils with sphinx, such that they are linked to a heading slug. The core behaviour for sphinx is not changed, except that failed reference resolution now emits a `myst.xref_missing` warning (as opposed to a `std.ref` one), with a clearer warning message. Also on failure, the reference is still created, for people who wish to suppress the warning (see e.g. #677)
-
-
Commits on Jan 12, 2023
-
⬆️ Update pytest requirement from <7,>=6 to >=7,<8 (#674)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
-
⬆️ Update sphinxext-opengraph requirement from ~=0.6.3 to ~=0.7.5 (#676)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
-
-
👌 Change non-fatal directive parsing errors to warnings (#682)
For non-fatal errors, such as; faulty options syntax, unknown option keys, and invalid option values, a warning is raised, but the directive is still run (without the erroneous options). The warning is given the `myst.directive_parse` type, which can be suppressed.
Commits on Jan 14, 2023
Commits on Jan 15, 2023
Commits on Jan 17, 2023
-
-
👌 Change missing directive/role errors to warnings (#687)
If an unknown directive/role name is encountered, then a warning is emitted with the `myst.directive_unknown` or `myst.role_unknown` type, which can be suppressed.
Commits on Feb 11, 2023
-
✨ NEW: extended URL link customisation (#695)
The `myst_url_schemes` configuration has been extended, in a back-compatible manner, to also allow writing as a dictionary, with customisations of the link URL/text, via templates, such as: ```python myst_url_schemes = { "http": None, "https": None, "wiki": "https://en.wikipedia.org/wiki/{{path}}#{{fragment}}", "gh-issue": { "url": "https://github.com/executablebooks/MyST-Parser/issue/{{path}}#{{fragment}}", "title": "Issue #{{path}}", "classes": ["github"], }, } ``` Allowing for `<gh-issue:639>` and `[URI](wiki:Uniform_Resource_Identifier#URI_references)`. The `inline_attrs` extension also allows for specific links to be marked as external, using `[](my-link){.external}`. -
👌 IMPROVE: Allow heading_slug_func to be a string (#696)
`myst_heading_slug_func` can now also be set to a string, which will be interpreted as an import path to a function, e.g. `myst_heading_slug_func = "mypackage.mymodule.slugify"`.
-
⬆️ Update pre-commit requirement from ~=2.12 to ~=3.0 (#693)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
Commits on Feb 19, 2023
-
✨ NEW: Add
attrs_blockextension (#703)By adding `"attrs_block"` to `myst_enable_extensions` (in the sphinx `conf.py`), you can enable parsing of inline attributes after certain inline syntaxes. This is adapted from [djot block attributes](https://htmlpreview.github.io/?https://github.com/jgm/djot/blob/master/doc/syntax.html#block-attributes)
-
📚 DOCS: Use
sphinx-autodoc2for API (#704)This will allow moving source docstrings to use MyST instead of rST 🎉
-
Commits on Feb 20, 2023
-
👌 IMPROVE: Allow setting {#id} on headings (#706)
For use with the `attrs_block` extension. This just moves around the logic for implicit heading anchors a bit (without changing anything user facing), to allow distinguishing between explicit and implicit heading ids.
-
Minor fix to stop the hover tips getting heading numbers
Commits on Feb 21, 2023
-
👌 Enhance
[](#id)references (#707)This PR moves myst-parser in the direction of jupyter-book/myst-enhancement-proposals#10, in a relatively back compatible manner, and in a way that supports both docutils and sphinx. It expands the capability of `[](#id)` to more than just linking to heading slugs, with the order of specificity being: 1. If it matches a local (to that document) "explicit" `std:ref` target, then link to that and stop - Note, currently only `std:ref` domain/type are supported, e.g. not `math` etc. That's more difficult and can come later 2. If it matches a local (to that document) "implicit" heading slug, then link to that and stop 3. If using docutils (i.e. single-page) build, then stop here and emit a `myst.xref_missing` warning 4. If using sphinx then create a `pending_xref` node, and hand-off to sphinx's "any" resolver, which takes effect once all documents have been read: - This first tries to resolve against a local (to the project) reference and, if matching, stops - Otherwise also try to match against any intersphinx reference - Otherwise emit a ~~`myst.ref`~~ `myst.xref_missing` warning If the text is explicit, e.g. `[text](#id)`, that text is used, otherwise a determination of implicit text is attempted, e.g. based on the section title or figure caption.
-
👌 Handling of nested headers (#711)
For the longest time, nested headers in myst-parser have been a pain, particularly in things like admonitions In Markdown (and HTML) headings are allowed "anywhere", for example: ```markdown > # Heading 1 ## Heading 2 Paragraph ``` Is rendered as: ```html <blockquote> <h1>Heading 1</h1> </blockquote> <h2>Heading 2</h2> <p>Paragraph</p> ``` However, because docutils/sphinx treats headers as nested sections, this becomes problematic ```xml <blockquote> <section> <title> Heading 1 <section> <title> Heading 2 <paragraph> Paragraph ``` Which sphinx cannot resolve the ToC tree from etc This PR fixes this, by identifying if a heading is inside another component and instead outputting it as a "non-structural" rubric node ```xml <blockquote> <rubric level=1> Heading 1 <section> <title> Heading 2 <paragraph> Paragraph ``` Natively, docutils/sphinx does not deal with the "level" key in the rubric, so here we also override the rubric HTML renderer to correctly output a `<h>` element, if "level" is present, to retrieve the desired: ```html <blockquote> <h1>Heading 1</h1> </blockquote> <h2>Heading 2</h2> <p>Paragraph</p> ``` There is no longer any warning of nested headers, since this is the intended behaviour To clarify, the logic is now: - A section can only be a child of the root document, or another section - If a header token is encountered, with a child that is not one of these, then it is added as a rubric - Otherwise a new section is created, and the heading is added as a title, which is a child of the section -
👌 Improve: Non-directive colon-fences (#713)
At present, colon fences without a directive specified (e.g. `:::{note}`) are treated as code bocks ``` :::name Some text ::: ``` ```xml <code language=name> Some text ``` In keeping with the purpose of these block, as containers for nested MyST content, they are now converted to: ```xml <div class=name> <paragraph> Some text ``` This is also in keeping with the original pandoc/djot inspiration <https://htmlpreview.github.io/?https://github.com/jgm/djot/blob/master/doc/syntax.html#div> -
🐛 FIX: colon_fence wrapping (#714)
Minor fix to the last commit 😅
Commits on Feb 22, 2023
-
🐛 FIX encoded URL ID references (#715)
For example `<#name with spaces>` will be encoded as `#name%20with%20spaces`, so we need to decode before resolving the reference.
-
👌 Improve
[](#target)resolution warnings (#716)Previously, if `[](#target)` matched nothing locally, but multiple items in intersphinx inventories, then no warning would be logged, and the first match silently used. Resolution of intersphinx now proceeds (if no local matches found) the same as for `[](inv:#target)`, such that a `myst.iref_ambiguous` warning is emitted in this case (the first match is then still used). Warnings coming from resolution of `[](#target)` can also now be "individually" turned off using https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpick_ignore, e.g. `nitpick_ignore = [("myst", "target")]`
Commits on Feb 23, 2023
-
👌 Improve: Apply implicit targets to nested headings (#718)
This commit builds on ac111ea, to allow for implicit heading slugs to be applied also to nested headings, i.e. so they can be referenced in Markdown links
-
✨ New: add .glossary for attrs_block (#719)
MyST follows Pandoc definition-lists, to denote lists of term -> definition. ```markdown Term 1 : Definition Term 2 : Definition ``` It should be easy for users to turn one of these lists into a glossary, where each term is uniquely referenceable across the entire project. This commit, allows this, via adding a `.glossary` class to the list: ```` {.glossary} Term 1 : Definition Term 2 : Definition ````
There are no files selected for viewing