Quo is a Python based toolkit for writing Command-Line Interface(CLI) applications.

Overview

Downloads PyPI version Wheel Windows Build Status pyimp RTD licence Twitter Follow

Logo

Forever Scalable

Quo is a Python based toolkit for writing Command-Line Interface(CLI) applications. Quo is making headway towards composing speedy and orderly CLI applications while forestalling any disappointments brought about by the failure to execute a CLI API. Simple to code, easy to learn, and does not come with needless baggage.

Quo requires Python 3.6.1 or later.

Features

  • Support for ANSI and RGB color models
  • Support for tabular presentation of data
  • Interactive progressbars
  • Code completions
  • Nesting of commands
  • Automatic help page generation
  • Highlighting
  • Lightweight

Getting Started

Installation

You can install quo via the Python Package Index (PyPI)

pip install -U quo

Quo print

Example 1

   from quo import echo
   echo(f"Hello, World!", fg="red", italic=True, bold=True))

Hello World

Example 2

   from quo import echo
   echo(f"Quo is ", nl=False)
   echo(f"scalable", bg="red", fg="black") 

Scalable

Unlike the builtin print function, echo function has improved support for handling Unicode and binary data. It also supports handling of ANSI color sequences.

Quo prompt

   from quo import prompt
   prompt("What is your name?")

prompt

Quo tabular

   from quo import echo
   from quo.tabulate import tabular

   table = [
     ["Name", "Gender", "Age"],
     ["Alice", "F", 24],
     ["Bob", "M", 19],
     ["Dave", "M", 24]
   ]

   echo(tabular(table))

tabulate

For more intricate examples, have a look in the tutorials directory and the documentation.

Donate 🎁

In order to for us to maintain this project and grow our community of contributors. Donate

Quo is...

Simple If you know Python you can easily use quo and it can integrate with just about anything.

Getting Help

Gitter

For discussions about the usage, development, and future of quo, please join our Gitter community

Resources

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at Bug tracker

License 📑

This software is licensed under the MIT License. See the License file in the top distribution directory for the full license text.

Code of Conduct

Code of Conduct is adapted from the Contributor Covenant, version 1.2.0 available at Code of Conduct

Comments
  • Import error within package

    Import error within package

    Describe the bug I tried to execute examples from README.md, this one is for prompt, however I get an ImportError

    >>> completer = quo.completion.WordCompleter(['USA', 'UK', 'Canada', 'Kenya'])
    >>> session = quo.Prompt(completer=completer)
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
      File "C:\Python\Python38\lib\site-packages\quo\shortcuts\prompt.py", line 452, in __init__
        self.app = self._create_application(editing_mode, erase_when_done)
      File "C:\Python\Python38\lib\site-packages\quo\shortcuts\prompt.py", line 703, in _create_application
        application: Suite[_T] = Suite(
      File "C:\Python\Python38\lib\site-packages\quo\suite\suite.py", line 280, in __init__
        self.output = output or session.output
      File "C:\Python\Python38\lib\site-packages\quo\suite\current.py", line 70, in output
        self._output = create_output()
      File "C:\Python\Python38\lib\site-packages\quo\output\defaults.py", line 59, in create_output
        from .console_emulator import ConEmu
      File "C:\Python\Python38\lib\site-packages\quo\output\console_emulator.py", line 8, in <module>
        from .win32 import Win32Output
      File "C:\Python\Python38\lib\site-packages\quo\output\win32.py", line 16, in <module>
        from quo.utils import get_cwidth
    ImportError: cannot import name 'get_cwidth' from 'quo.utils' (C:\Python\Python38\lib\site-packages\quo\utils\__init__.py)
    

    To Reproduce Steps to reproduce the behavior:

    1. Try to execute example
    import quo
    
    completer = quo.completion.WordCompleter(['USA', 'UK', 'Canada', 'Kenya'])
    session = quo.Prompt(completer=completer)
    session.prompt('Which country are you from?: ')
    
    1. See error

    Expected behavior Not throw an error.

    Desktop (please complete the following information):

    • OS: Windows 10 x64
    • Python version: 3.8
    • Quo version: 2021.07
    bug 
    opened by XCanG 4
  • Missing dependency and .flair() function not available.

    Missing dependency and .flair() function not available.

    Describe the bug wcwidth is a required module but deosn't get installed when installing quo via pip. The examples refer to quo.flair() but it doesn't seem to have such a function

    To Reproduce

    import quo quo.flair(f'Hello, World!', fg="red", bold=True) Traceback (most recent call last): File "", line 1, in AttributeError: module 'quo' has no attribute 'flair'

    Expected behavior .flair() function should be available

    Screenshots image

    Desktop (please complete the following information):

    • OS: Mac OSX Big Sur with Homebrew
    • Python 3.9.6 (installed via Homebrew).
    bug enhancement 
    opened by fahadysf 4
  • [BUG]

    [BUG]

    You may find a solution to your problem in the docs or issues.

    Describe the bug :meth:quo.console.Console.size object not Callable

    To Reproduce Steps to reproduce the behavior:

    1. Go to '...'
    2. Click on '....'
    3. Scroll down to '....'
    4. See error

    Expected behavior A clear and concise description of what you expected to happen.

    Screenshots If applicable, add screenshots to help explain your problem.

    Desktop (please complete the following information):

    • OS: [e.g. iOS]
    • Browser [e.g. chrome, safari]
    • Version [e.g. 22]

    Smartphone (please complete the following information):

    • Device: [e.g. iPhone6]
    • OS: [e.g. iOS8.1]
    • Browser [e.g. stock browser, safari]
    • Version [e.g. 22]

    Additional context Add any other context about the problem here.

    opened by gerrishons 3
  • Fix 'TODO: not entirely correct yet in case of line wrapping and long lines.' issue in src\quo\layout\containers.py

    Fix 'TODO: not entirely correct yet in case of line wrapping and long lines.' issue in src\quo\layout\containers.py

    opened by gerrishons 1
  • Fix 'Undefined variable name 'split_lines' in __all__' issue in src\quo\text\__init__.py

    Fix 'Undefined variable name 'split_lines' in __all__' issue in src\quo\text\__init__.py

    CodeFactor found an issue: Undefined variable name 'split_lines' in all

    It's currently on: src\quo\text_init_.py:52 Commit 906a7e424bfb256d8541c6e9c6e550fe3b7b1b7e

    no-issue-activity 
    opened by gerrishons 1
  • unicode characters not displaying on windows

    unicode characters not displaying on windows

    You may find a solution to your problem in the docs or issues.

    Describe the bug A clear and concise description of what the bug is.

    To Reproduce Steps to reproduce the behavior:

    1. Go to '...'
    2. Click on '....'
    3. Scroll down to '....'
    4. See error

    Expected behavior A clear and concise description of what you expected to happen.

    Screenshots If applicable, add screenshots to help explain your problem.

    Desktop (please complete the following information):

    • OS: [e.g. iOS, Ubuntu]
    • Version [e.g. 22]

    Android(please complete the following information):

    • Model [e.g. Samsung]
    • OS: [eg. Android 11]
    • App [e.g. Termux]
    • Version [e.g. 22]

    Additional context Add any other context about the problem here.

    opened by gerrishons 1
  • Bug #12345 Scheduled daily dependency update on Tuesday

    Bug #12345 Scheduled daily dependency update on Tuesday

    Update secretum_sphinx_theme from 2022.1 to 2022.1.

    The bot wasn't able to find a changelog for this release. Got an idea?

    Links
    • PyPI: https://pypi.org/project/secretum-sphinx-theme
    • Repo: https://github.com/secretum-inc/secretum_sphinx_theme/archive/v2022.1.tar.gz

    Update myst_parser from 0.17.0 to 0.17.0.

    Changelog

    0.17.0

    This release contains a number of breaking improvements.
    
    Full Changelog: [v0.16.1...v0.17.0](https://github.com/executablebooks/MyST-Parser/compare/v0.16.1...v0.17.0)
    
    ‼️ Markdown link resolution improvements
    
    Markdown links are of the format `[text](link)`.
    MyST-Parser looks to smartly resolve such links, by identifying if they are:
    
    1. A link to an external resource, e.g. `[text](http://example.com)`
    2. A link to another source document, e.g. `[text](file.md)`
    - If `header-anchors` are enabled, anchor links are also supported, e.g. `[text](file.mdanchor)`
    3. A link to an internal sphinx cross-reference, e.g. `[text](my-reference)`
    
    an additional situation is now supported:
    
    4. A link to a source file, which is not a document, e.g. `[text](file.js)`. This behaves similarly to the sphinx `download` role.
    
    In addition, configuration to more finely tune this behaviour has been added.
    
    - `myst_all_links_external=True`, will make all links be treated as (1)
    - `myst_url_schemes=(&quot;http&quot;, &quot;https&quot;)`, sets what URL schemes are treated as (1)
    - `myst_ref_domains=(&quot;std&quot;, &quot;py&quot;)`, sets what Sphinx reference domains are checked, when handling (3)
    
    See [Markdown Links and Referencing](docs/syntax/syntax.mdmarkdown-links-and-referencing) for more information.
    
    ‼️ Dollarmath is now disabled by default
    
    The default configuration is now `myst_enable_extensions=()`, instead of `myst_enable_extensions=(&quot;dollarmath&quot;,)`.
    If you are using math enclosed in `$` or `$$` in your documents, you should enable `dollarmath` explicitly.
    
    See [Dollar delimited math](docs/syntax/optional.mdmath-shortcuts) for more information.
    
    ⬆️ Drop Python 3.6 support
    
    MyST-Parser now supports, and is tested against, Python 3.7 to 3.10.
    
    ✨ Add the `strikethrough` extension and `myst_gfm_only` configuration
    
    The `strikethrough` extension allows text within `~~` delimiters to have a strike-through (horizontal line) placed over it.
    For example, `~~strikethrough with *emphasis*~~` renders as: ~~strikethrough with *emphasis*~~.
    
    **Important**: This extension is currently only supported for HTML output.
    
    See [Strikethrough](docs/syntax/optional.mdstrikethrough) for more information.
    
    The `myst_gfm_only=True` configuration sets up specific configuration, to enable compliance only with [GitHub-flavored Markdown](https://github.github.com/gfm/), including enabling the `strikethrough`, `tasklist` and `linkify` extensions, but disabling support for roles and directives.
    
    ✨ Add `myst_title_to_header` configuration
    
    Setting `myst_title_to_header=True`, allows for a `title` key in the frontmatter to be used as the document title.
    for example:
    
    md
    ---
    title: My Title with *emphasis*
    ---
    
    
    would be equivalent to:
    
    md
    My Title with *emphasis*
    
    
    See [Front matter](docs/syntax/syntax.mdfront-matter) for more information.
    
    👌 Internal improvements
    
    👌 IMPROVE: Convert nested headings to rubrics.
    Headings within directives are not directly supported by sphinx, since they break the structure of the document. Previously myst-parser would emit a `myst.nested_header` warning, but still generate the heading, leading to unexpected outcomes.
    Now the warning is still emitted, but also the heading is rendered as a [rubric](https://docutils.sourceforge.io/docs/ref/rst/directives.html#rubric) non-structural heading (i.e. it will not show in the ToC).
    
    Other internal improvements primarily focussed in improving support for the for &quot;docutils-only&quot; use, introduced in `v0.16`:
    
    - ♻️ REFACTOR: `default_parser` -&gt; `create_md_parser` in [474](https://github.com/executablebooks/MyST-Parser/pull/474)
    - 👌 IMPROVE: Add `bullet` attribute to `bullet_list` node in [465](https://github.com/executablebooks/MyST-Parser/pull/465)
    - 👌 IMPROVE: Use correct renderer for `state.inline_text` in [466](https://github.com/executablebooks/MyST-Parser/pull/466)
    - 👌 IMPROVE: Docutils parser settings in [476](https://github.com/executablebooks/MyST-Parser/pull/476)
    - 🐛 FIX: front-matter rendering with docutils in [477](https://github.com/executablebooks/MyST-Parser/pull/477)
    - 👌 IMPROVE: Code block highlighting in [478](https://github.com/executablebooks/MyST-Parser/pull/478)
    - 👌 IMPROVE: `note_refname` for docutils internal links in [481](https://github.com/executablebooks/MyST-Parser/pull/481)
    - 🐛 FIX: Ordered list starting number in [483](https://github.com/executablebooks/MyST-Parser/pull/483)
    - 👌 IMPROVE: Propagate enumerated list suffix in [484](https://github.com/executablebooks/MyST-Parser/pull/484)
    - 👌 IMPROVE: `DocutilsRenderer.create_highlighted_code_block` in [488](https://github.com/executablebooks/MyST-Parser/pull/488)
    - 🐛 FIX: Source line reporting for nested parsing in [490](https://github.com/executablebooks/MyST-Parser/pull/490)
    - 🔧 MAINTAIN: Implement `MockInliner.parse` in [504](https://github.com/executablebooks/MyST-Parser/pull/504)
    

    0.16.1

    ✨ NEW: Add `myst_linkify_fuzzy_links` option.
    When using the [`linkify` extension](docs/syntax/optional.mdlinkify), this option can be used to disable matching of links that do not contain a schema (such as `http://`).
    

    0.16.0

    This release contains a number of exciting improvements:
    
    Upgrade of Markdown parser
    
    `markdown-it-py` has been upgraded to [v2.0.0](https://github.com/executablebooks/markdown-it-py/releases/tag/v2.0.0).
    This upgrade brings full compliance with the [CommonMark v0.30 specification](https://spec.commonmark.org/0.30/).
    
    Additionally, `mdit-py-plugins` has been upgraded to [v0.3.0](https://github.com/executablebooks/mdit-py-plugins/releases/tag/v0.3.0).
    This improves the parsing of the MyST target syntax, to allow for spaces and additional special characters in the target name,
    for example this is now valid:
    
    md
    (a bc   |&lt;&gt;*./_-+:)=
    
    Header
    
    
    Also MyST role syntax now supports unlimited length in the role name and new lines in the content.
    For example, this is now valid:
    
    md
    {abc}`xy
    new line`
    
    
    Improvements for Docutils-only use
    
    MyST now allows for Docutils-only use (outside of Sphinx), that allows for MyST configuration options to be set via the `docutils.conf` file, or on the command line.
    
    On installing MyST-Parser, the following CLI-commands are made available:
    
    - `myst-docutils-html`: converts MyST to HTML
    - `myst-docutils-html5`: converts MyST to HTML5
    - `myst-docutils-latex`: converts MyST to LaTeX
    - `myst-docutils-xml`: converts MyST to docutils-native XML
    - `myst-docutils-pseudoxml`: converts MyST to pseudo-XML (to visualise the AST structure)
    
    You can also install the [myst-docutils](https://pypi.org/project/myst-docutils/) package from `pip`,
    which includes no direct install requirements on docutils or sphinx.
    
    See [MyST with Docutils](docs/docutils.md) for more information.
    
    Thanks to help from [cpitclaudel](https://github.com/cpitclaudel)!
    
    Include MyST files in RST files
    
    With `docutils&gt;=0.17`, the `include` directive has a `parser` option.
    This can be used with myst-parser to include MyST files in RST files.
    
    md
    Parse using the docutils only parser:
    
    .. include:: include.md
    :parser: myst_parser.docutils_
    
    Parse using the sphinx parser:
    
    .. include:: include.md
    :parser: myst_parser.sphinx_
    
    
    Addition of the `fieldlist` syntax extension
    
    Field lists are mappings from field names to field bodies, based on the [reStructureText syntax](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists):
    
    rst
    :name only:
    :name: body
    :name:
    Multiple
    
    Paragraphs
    
    
    This should eventually allow for MyST Markdown docstrings! (see &lt;https://github.com/executablebooks/MyST-Parser/issues/228&gt;)
    
    See [Field Lists syntax](docs/syntax/optional.mdfield-lists) for more information.
    
    Improvements to table rendering
    
    Tables with no body are now allowed, for example:
    
    md
    | abc | def |
    | --- | --- |
    
    
    Also cell alignment HTML classes have now been changed to: `text-left`, `text-center`, or `text-right`, for example:
    
    md
    | left | center | right |
    | :--- | :----: | ----: |
    | a    | b      | c     |
    
    
    is converted to:
    
    html
    &lt;table class=&quot;colwidths-auto&quot;&gt;
    &lt;thead&gt;
    &lt;tr&gt;
     &lt;th class=&quot;text-left head&quot;&gt;&lt;p&gt;left&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-center head&quot;&gt;&lt;p&gt;center&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-right head&quot;&gt;&lt;p&gt;right&lt;/p&gt;&lt;/th&gt;
    &lt;/tr&gt;
    &lt;/thead&gt;
    &lt;tbody&gt;
    &lt;tr&gt;
     &lt;td class=&quot;text-left&quot;&gt;&lt;p&gt;a&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-center&quot;&gt;&lt;p&gt;b&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-right&quot;&gt;&lt;p&gt;c&lt;/p&gt;&lt;/td&gt;
    &lt;/tr&gt;
    &lt;/tbody&gt;
    &lt;/table&gt;
    
    
    These classes should be supported by most sphinx HTML themes.
    
    See [Tables syntax](docs/syntax/syntax.mdtables) for more information.
    
    Pull Requests
    
    - 🐛 FIX: Add mandatory attributes on `enumerated_list` by cpitclaudel in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - 📚 DOCS: Add reference to MySTyc in landing page by astrojuanlu in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    - ⬆️ UPGRADE: markdown-it-py v2, mdit-py-plugins v0.3 by chrisjsewell in [449](https://github.com/executablebooks/MyST-Parser/pull/449)
    - 👌 IMPROVE: Table rendering by chrisjsewell in [450](https://github.com/executablebooks/MyST-Parser/pull/450)
    - 🐛 FIX: Ensure parent files are re-built if `include` file changes by chrisjsewell in [451](https://github.com/executablebooks/MyST-Parser/pull/451)
    - 🐛 FIX: Convert empty directive option to `None` by chrisjsewell in [452](https://github.com/executablebooks/MyST-Parser/pull/452)
    - 👌 IMPROVE: Add `\\` for hard-breaks in latex by chrisjsewell in [453](https://github.com/executablebooks/MyST-Parser/pull/453)
    - 🔧 MAINTAIN: Remove empty &quot;sphinx&quot; extra by hukkin in [350](https://github.com/executablebooks/MyST-Parser/pull/350)
    - ✨ NEW: Add `fieldlist` extension by chrisjsewell in [455](https://github.com/executablebooks/MyST-Parser/pull/455)
    - ✨ NEW: Add Docutils MyST config and CLI by cpitclaudel in [426](https://github.com/executablebooks/MyST-Parser/pull/426)
    - 🔧 MAINTAIN: Add publishing job for `myst-docutils` by chrisjsewell in [456](https://github.com/executablebooks/MyST-Parser/pull/456)
    - 🧪 TESTS: Add for `gettext_additional_targets` by jpmckinney in [459](https://github.com/executablebooks/MyST-Parser/pull/459)
    
    New Contributors
    
    - cpitclaudel made their first contribution in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - astrojuanlu made their first contribution in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    
    **Full Changelog**: &lt;https://github.com/executablebooks/MyST-Parser/compare/v0.15.2...v0.16.0&gt;
    

    0.15.2

    This is mainly a maintenance release that fixes some incompatibilities with `sphinx&lt;3.1`, improvements for compatibility
    with `docutils=0.17`, and improvements to robustness.
    

    0.15.1

    👌 IMPROVE: MathJax compatibility with `nbsphinx`
    
    `nbsphinx` also overrides the MathJax configuration.
    For compatibility, `output_area` is added to the list of default processed classes, and the override warning is allowed to be suppressed with `suppress_warnings = [&quot;myst.mathjax&quot;]`.
    

    0.15.0

    Upgraded to `sphinx` v4 ⬆️
    
    A principe change in this release is to updates the requirements of myst-parser from `sphinx&gt;=2,&lt;4` to `sphinx&gt;=3,&lt;5`.
    
    Changed MathJax handling ♻️
    
    Instead of removing all `$` processing for the whole project,
    during MyST document parsing, the top-level section is now given the classes `tex2jax_ignore` and `mathjax_ignore` (turning off default MathJax processing of all HTML elements)
    and MathJax is then configured to process elements with the `tex2jax_process|mathjax_process|math` classes.
    
    See [the math syntax guide](docs/syntax/optional.mdmath-shortcuts) for further information.
    
    Set URL scheme defaults ‼️
    
    The `myst_url_schemes` default is now: `(&quot;http&quot;, &quot;https&quot;, &quot;mailto&quot;, &quot;ftp&quot;)`.
    This means that only these URL will be considered as external (e.g. `[](https://example.com)`),
    and references like `[](prefix:main)` will be considered as internal references.
    Set `myst_url_schemes = None`, to revert to the previous default.
    
    Added `myst_heading_slug_func` option 👌
    
    Use this option to specify a custom function to auto-generate heading anchors (see [Auto-generated header anchors](docs/syntax/optional.mdauto-generated-header-anchors)).
    
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    

    0.13.7

    👌 IMPROVE: Add warning for nested headers:
    
    Nested headers are not supported within most elements (this is a limitation of the docutils/sphinx document structure), and can lead to unexpected outcomes.
    For example in admonitions:
    
    `markdown
    {note}
    Unsupported Header
    
    `
    
    A warning (of type `myst.nested_header`) is now emitted when this occurs.
    
    🔧 MAINTAIN: Python 3.9 is now officially supported.
    

    0.13.6

    🐛 FIX: docutils `v0.17` compatibility
    

    0.13.5

    - ⬆️ UPGRADE: required markdown-it-py to `v0.6.2`:
    In particular, this fixes missing source line mappings for table rows and their children
    - 👌 IMPROVE: Store `rawtext` in AST nodes:
    We now ensure that the raw text is propagated from the Markdown tokens to the Sphinx AST.
    In particular, this is required by the `gettext` builder, to generate translation POT templates.
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    - ✨ NEW: Add warning types `myst.subtype`:
    All parsing warnings are assigned a type/subtype, and also the messages are appended with them.
    These warning types can be suppressed with the sphinx `suppress_warnings` config option.
    See [How-to suppress warnings](howto/warnings) for more information.
    

    0.13.3

    Minor fixes:
    
    - 🐛 FIX: front-matter parsing for bibliographic keys
    - 🐛 FIX: directive/role name translations
    - 👌 IMPROVE: Add warning for multiple footnote definitions
    

    0.13.2

    ✨ NEW: Add `html_admonition` extension
    
    : By adding `&quot;html_admonition&quot;` to `myst_enable_extensions`, you can enable parsing of `&lt;div class=&quot;admonition&quot;&gt;` HTML blocks to sphinx admonitions.
    : This is helpful when you care about viewing the &quot;source&quot; Markdown, such as in Jupyter Notebooks.
    : For example:
    html
    &lt;div class=&quot;admonition note&quot; name=&quot;html-admonition&quot;&gt;
    &lt;p class=&quot;title&quot;&gt;This is the **title**&lt;/p&gt;
    This is the *content*
    &lt;/div&gt;
    
    : See [the optional syntax guide](docs/syntax/optional.md) for further information.
    
    👌 IMPROVE: Footnotes
    
    : If the label is an integer, then it will always use this integer for the rendered label (i.e. they are manually numbered).
    : Add `myst_footnote_transition` configuration, to turn on/off transition line.
    : Add `footnotes` class to transition `&lt;hr&gt;` in HTML.
    : See [the syntax guide](docs/syntax/syntax.md) for further information.
    
    👌 IMPROVE: `substitution` extension logic
    
    : Parse inline substitutions without block rules, unless the substitution starts with a directive.
    
    🐛 FIX: Render front-matter as `field_list`
    
    : To improve use by sphinx extensions).
    
    👌 IMPROVE: Code quality
    
    : Add isort and mypy type checking to code base.
    
    (thanks to contributors akhmerov, tfiers)
    

    0.13.1

    👌 Directives can now be used for inline substitutions, e.g.
    
    md
    ---
    substitutions:
    key: |
     {image} img/fun-fish.png
     :alt: fishy
     :height: 20px
     
    ---
    
    An inline image: {{ key }}
    

    0.13.0

    This release makes some major updates to the optional syntaxes.
    For full details see [Optional MyST Syntaxes](docs/syntax/optional.md).
    
    🗑 Deprecations
    
    `myst_enable_extensions = [&quot;dollarmath&quot;, ...]` now replaces and deprecates individual enable configuration variables: `admonition_enable` -&gt; `&quot;colon_fence&quot;`, `figure_enable` -&gt; `&quot;colon_fence&quot;`, `dmath_enable` -&gt; `&quot;dollarmath&quot;`, `amsmath` -&gt; `&quot;colon_fence&quot;`, `deflist_enable` -&gt; `&quot;deflist&quot;`, `html_img_enable` -&gt; `&quot;html_image&quot;`.
    
    The `colon_fence` extension (replacing `admonition_enable`) now works exactly the same as normal `  ` code fences, but using `:::` delimiters. This is helpful for directives that contain Markdown text, for example:
    
    md
    :::{admonition} The title
    :class: note
    
    This note contains *Markdown*
    :::
    
    
    ✨ New
    
    The `smartquotes` extension will automatically convert standard quotations to their opening/closing variants:
    
    - `&#x27;single quotes&#x27;`: ‘single quotes’
    - `&quot;double quotes&quot;`:  “double quotes”
    
    The `linkify` extension will automatically identify “bare” web URLs, like `www.example.com`,  and add hyperlinks; www.example.com.
    This extension requires that [linkify-it-py](https://github.com/tsutsu3/linkify-it-py) is installed.
    
    The `replacements` extension will automatically convert some common typographic texts, such as `+-` -&gt; `±`.
    
    The `substitution` extension allows you to specify &quot;substitution definitions&quot; in either the `conf.py` (as `myst_substitutions`) and/or individual file&#x27;s front-matter (front-matter takes precedence), which will then replace substitution references. For example:
    
    md
    ---
    substitutions:
    key1: definition
    ---
    {{ key1 }}
    
    
    The substitutions are assessed as [jinja2 expressions](http://jinja.palletsprojects.com/) and includes the [Sphinx Environment](https://www.sphinx-doc.org/en/master/extdev/envapi.html) as `env`, so you can do powerful thinks like:
    
    
    {{ [key1, env.docname] | join(&#x27;/&#x27;) }}
    
    
    The `figure-md` directive has been added (replacing `enable_figure`), which parses a &quot;Markdown friendly&quot; figure (used with the `colon_fence` extension):
    
    md
    :::{figure-md} fig-target
    :class: myclass
    
    &lt;img src=&quot;img/fun-fish.png&quot; alt=&quot;fishy&quot; class=&quot;bg-primary mb-1&quot; width=&quot;200px&quot;&gt;
    
    This is a caption in **Markdown**
    :::
    
    
    👌 Improvements
    
    Using the `html_image` extension, HTML images are now processed for both blocks and (now) inline.
    
    So you can correctly do, for example:
    
    md
    I’m an inline image: &lt;img src=&quot;img/fun-fish.png&quot; height=&quot;20px&quot;&gt;
    
    | table column                              |
    | ----------------------------------------- |
    | &lt;img src=&quot;img/fun-fish.png&quot; width=&quot;20px&quot;&gt; |
    

    0.12.10

    🐛 FIX: allow dates to be parsed in frontmatter.
    : This fixes a bug that would raise errors at parse time if non-string date objects were in front-matter YAML. See [253](https://github.com/executablebooks/MyST-Parser/pull/253)
    

    0.12.9

    ✨ NEW: Auto-generate heading anchors.
    : This utilises `markdown-it-py`&#x27;s `anchors-plugin`, to generate unique anchor &quot;slugs&quot; for each header (up to a certain level),
    and allows them to be referenced *via* a relative path, e.g. `[](./file.mdheader-anchor)`, or in the same document, e.g. `[](header-anchor)`.
    
    Slugs are generated in the GitHub style ([see here](https://github.com/Flet/github-slugger)); lower-case text, removing punctuation, replacing spaces with `-`, enforce uniqueness *via* suffix enumeration `-1`.
    
    It is enabled in your `conf.py` *via* `myst_heading_anchors = 2` (sets maximum heading level).
    
    See [the documentation here](docs/syntax/optional.mdauto-generated-header-anchors).
    
    🐛 FIX: doc reference resolution for singlehtml/latex.
    : These reference resolutions are passed to the &quot;missing-reference&quot; event, and require the `node[&quot;refdoc&quot;]` attribute to be available, which was missing for `[text](./path/to/file.md)` type references.
    

    0.12.7

    ✨ NEW: Want to include your README.md in the documentation?
    : See [including a file from outside the docs folder](howto/include-readme).
    

    0.12.5

    ✨ NEW: Add Markdown figure syntax
    : Setting `myst_figure_enable = True` in your sphinx `conf.py`, combines the above two extended syntaxes,
    to create a fully Markdown compliant version of the `figure` directive.
    See [Markdown Figures](docs/syntax/optional.mdmarkdown-figures) for details.
    

    0.12.4

    👌 IMPROVE: the mathjax extension is now only overridden if strictly necessary (to support dollar and ams math), and the override is more precise, to mitigate any unwanted side-effects
    

    0.12.3

    ✨ NEW: Add definition lists.
    : This addition, enabled by `myst_deflist_enable = True`, allows for &quot;Pandoc style&quot; definition lists to be parsed and rendered, e.g.
    
    md
    Term 1
    : Definition
    
    
    See the [Definition Lists documentation](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists) for further details.
    
    👌 IMPROVE: mathjax_config override.
    : Only `mathjax_config[&quot;tex2jax&quot;]` will now be overridden, in order to not interfere with other user configurations, such as adding TeX macros.
    The configuration name has also changed from `myst_override_mathjax` to `myst_update_mathjax`.
    See [Mathjax and math parsing](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#mathjax-and-math-parsing) for further details.
    

    0.12.2

    ✨ NEW: Add the `eval-rst` directive
    
    : This directive parses its contents as ReStructuredText, which integrates back into the rest of the document, e.g. for cross-referencing. See [this documentation](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#how-directives-parse-content) for further explanation.
    
    In particular, this addition solves some outstanding user requests:
    
    - How-to [include rST files into a Markdown file](https://myst-parser.readthedocs.io/en/latest/using/howto.html#include-rst-files-into-a-markdown-file)
    - How-to [Use sphinx.ext.autodoc in Markdown files](https://myst-parser.readthedocs.io/en/latest/using/howto.html#use-sphinx-ext-autodoc-in-markdown-files)
    
    Thanks to [stephenroller](https://github.com/stephenroller) for the contribution 🎉
    

    0.12.1

    ✨ NEW: Add `myst_commonmark_only` config option, for restricting the parser to strict CommonMark (no extensions).
    

    0.12.0

    ‼️ BREAKING
    
    If you are using math in your documents, be sure to read the updated [Math syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#math-shortcuts)!
    In particular, the Mathjax configuration is now overridden, such that LaTeX environments will only be rendered if `myst_amsmath_enable=True` is set.
    
    The `myst_math_delimiters` option has also been removed (please open an issue if you would like brackets math parsing to be re-implemented).
    
    In addition the `myst_html_img` option name has been changed to `myst_html_img_enable`.
    
    Some underlying code has also been refactored, to centralise handling of configuration options (see [commit 98573b9](https://github.com/executablebooks/MyST-Parser/commit/98573b9c6e3602ab31d627b5266ae5c1ba2c9e5f)).
    
    Improved 👌
    
    More configuration options for math parsing (see [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)).
    

    0.11.2

    Added ✨
    
    - `&lt;img src=&quot;file.png&quot; width=&quot;200px&quot;&gt;` tag parsing to sphinx representation, see [the image syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#images)
    
    Improved 👌
    
    - `[title](link)` syntax now works with intersphinx references.
    Recognised URI schemas can also be configured, see the [configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)
    

    0.11.1

    Fix
    
    - Correctly pin required minimum markdown-it-py version
    

    0.11.0

    Added ✨
    
    * Special admonition directive syntax (optional):
    
    md
    :::{note}
    This text is **standard** _Markdown_
    :::
    
    
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#admonition-directives-special-syntax-optional) for details.
    
    * Direct parsing of [amsmath](https://ctan.org/pkg/amsmath) LaTeX equations (optional).
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#direct-latex-math-optional) for details.
    
    Breaking ‼️
    
    * Sphinx configuration options are now set as separate variables, rather than a single dict.
    See [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options) for details.
    

    0.10.0

    ([full changelog](https://github.com/executablebooks/MyST-Parser/compare/v0.9.1...aaed58808af485c29bbbf73c5aac10697bfa08b9))
    
    Improved 👌
    
    * Support Sphinx version 3 [197](https://github.com/executablebooks/MyST-Parser/pull/197) ([chrisjsewell](https://github.com/chrisjsewell))
    * Update Trove Classifiers [192](https://github.com/executablebooks/MyST-Parser/pull/192) ([chrisjsewell](https://github.com/chrisjsewell))
    * Add functionality to use docutils specialized role [189](https://github.com/executablebooks/MyST-Parser/pull/189) ([chrisjsewell](https://github.com/chrisjsewell))
    
    Contributors to this release
    
    ([GitHub contributors page for this release](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-07-20&amp;to=2020-08-07&amp;type=c))
    
    [AakashGfude](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3AAakashGfude+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [welcome](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awelcome+updated%3A2020-07-20..2020-08-07&amp;type=Issues)
    
    Past Releases
    
    Contributors
    
    ([GitHub contributors page for these releases](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-01-01&amp;to=2020-07-20&amp;type=c))
    
    [akhmerov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aakhmerov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [certik](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acertik+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [dhermes](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Adhermes+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [filippo82](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Afilippo82+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jlperla](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajlperla+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jstac](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajstac+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [martinagvilas](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amartinagvilas+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mlncn](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amlncn+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mmcky](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ammcky+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [moorepants](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amoorepants+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [najuzilu](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anajuzilu+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [nathancarter](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anathancarter+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [pauleveritt](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Apauleveritt+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [phaustin](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aphaustin+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rossbar](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arossbar+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rowanc1](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arowanc1+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [sbliven](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Asbliven+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-01-01..2020-07-20&amp;type=Issues)
    
    Links
    • PyPI: https://pypi.org/project/myst-parser
    • Changelog: https://pyup.io/changelogs/myst-parser/
    • Repo: https://github.com/executablebooks/MyST-Parser

    Update pytest from 7.0.0 to 7.0.1.

    Changelog

    7.0.1

    =========================
    
    Bug Fixes
    ---------
    
    - `9608 &lt;https://github.com/pytest-dev/pytest/issues/9608&gt;`_: Fix invalid importing of ``importlib.readers`` in Python 3.9.
    
    
    - `9610 &lt;https://github.com/pytest-dev/pytest/issues/9610&gt;`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method.
    Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`.
    Regressed in pytest 7.0.0.
    
    
    - `9636 &lt;https://github.com/pytest-dev/pytest/issues/9636&gt;`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin.
    
    
    - `9642 &lt;https://github.com/pytest-dev/pytest/issues/9642&gt;`_: Fix running tests by id with ``::`` in the parametrize portion.
    
    
    - `9643 &lt;https://github.com/pytest-dev/pytest/issues/9643&gt;`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and
    :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters &lt;warnings&gt;`.
    
    Links
    • PyPI: https://pypi.org/project/pytest
    • Changelog: https://pyup.io/changelogs/pytest/
    • Homepage: https://docs.pytest.org/en/latest/
    update 
    opened by pyup-bot 1
  • Bug #12345 Scheduled daily dependency update on Monday

    Bug #12345 Scheduled daily dependency update on Monday

    Update secretum_sphinx_theme from 2022.1 to 2022.1.

    The bot wasn't able to find a changelog for this release. Got an idea?

    Links
    • PyPI: https://pypi.org/project/secretum-sphinx-theme
    • Repo: https://github.com/secretum-inc/secretum_sphinx_theme/archive/v2022.1.tar.gz

    Update myst_parser from 0.17.0 to 0.17.0.

    Changelog

    0.17.0

    This release contains a number of breaking improvements.
    
    Full Changelog: [v0.16.1...v0.17.0](https://github.com/executablebooks/MyST-Parser/compare/v0.16.1...v0.17.0)
    
    ‼️ Markdown link resolution improvements
    
    Markdown links are of the format `[text](link)`.
    MyST-Parser looks to smartly resolve such links, by identifying if they are:
    
    1. A link to an external resource, e.g. `[text](http://example.com)`
    2. A link to another source document, e.g. `[text](file.md)`
    - If `header-anchors` are enabled, anchor links are also supported, e.g. `[text](file.mdanchor)`
    3. A link to an internal sphinx cross-reference, e.g. `[text](my-reference)`
    
    an additional situation is now supported:
    
    4. A link to a source file, which is not a document, e.g. `[text](file.js)`. This behaves similarly to the sphinx `download` role.
    
    In addition, configuration to more finely tune this behaviour has been added.
    
    - `myst_all_links_external=True`, will make all links be treated as (1)
    - `myst_url_schemes=(&quot;http&quot;, &quot;https&quot;)`, sets what URL schemes are treated as (1)
    - `myst_ref_domains=(&quot;std&quot;, &quot;py&quot;)`, sets what Sphinx reference domains are checked, when handling (3)
    
    See [Markdown Links and Referencing](docs/syntax/syntax.mdmarkdown-links-and-referencing) for more information.
    
    ‼️ Dollarmath is now disabled by default
    
    The default configuration is now `myst_enable_extensions=()`, instead of `myst_enable_extensions=(&quot;dollarmath&quot;,)`.
    If you are using math enclosed in `$` or `$$` in your documents, you should enable `dollarmath` explicitly.
    
    See [Dollar delimited math](docs/syntax/optional.mdmath-shortcuts) for more information.
    
    ⬆️ Drop Python 3.6 support
    
    MyST-Parser now supports, and is tested against, Python 3.7 to 3.10.
    
    ✨ Add the `strikethrough` extension and `myst_gfm_only` configuration
    
    The `strikethrough` extension allows text within `~~` delimiters to have a strike-through (horizontal line) placed over it.
    For example, `~~strikethrough with *emphasis*~~` renders as: ~~strikethrough with *emphasis*~~.
    
    **Important**: This extension is currently only supported for HTML output.
    
    See [Strikethrough](docs/syntax/optional.mdstrikethrough) for more information.
    
    The `myst_gfm_only=True` configuration sets up specific configuration, to enable compliance only with [GitHub-flavored Markdown](https://github.github.com/gfm/), including enabling the `strikethrough`, `tasklist` and `linkify` extensions, but disabling support for roles and directives.
    
    ✨ Add `myst_title_to_header` configuration
    
    Setting `myst_title_to_header=True`, allows for a `title` key in the frontmatter to be used as the document title.
    for example:
    
    md
    ---
    title: My Title with *emphasis*
    ---
    
    
    would be equivalent to:
    
    md
    My Title with *emphasis*
    
    
    See [Front matter](docs/syntax/syntax.mdfront-matter) for more information.
    
    👌 Internal improvements
    
    👌 IMPROVE: Convert nested headings to rubrics.
    Headings within directives are not directly supported by sphinx, since they break the structure of the document. Previously myst-parser would emit a `myst.nested_header` warning, but still generate the heading, leading to unexpected outcomes.
    Now the warning is still emitted, but also the heading is rendered as a [rubric](https://docutils.sourceforge.io/docs/ref/rst/directives.html#rubric) non-structural heading (i.e. it will not show in the ToC).
    
    Other internal improvements primarily focussed in improving support for the for &quot;docutils-only&quot; use, introduced in `v0.16`:
    
    - ♻️ REFACTOR: `default_parser` -&gt; `create_md_parser` in [474](https://github.com/executablebooks/MyST-Parser/pull/474)
    - 👌 IMPROVE: Add `bullet` attribute to `bullet_list` node in [465](https://github.com/executablebooks/MyST-Parser/pull/465)
    - 👌 IMPROVE: Use correct renderer for `state.inline_text` in [466](https://github.com/executablebooks/MyST-Parser/pull/466)
    - 👌 IMPROVE: Docutils parser settings in [476](https://github.com/executablebooks/MyST-Parser/pull/476)
    - 🐛 FIX: front-matter rendering with docutils in [477](https://github.com/executablebooks/MyST-Parser/pull/477)
    - 👌 IMPROVE: Code block highlighting in [478](https://github.com/executablebooks/MyST-Parser/pull/478)
    - 👌 IMPROVE: `note_refname` for docutils internal links in [481](https://github.com/executablebooks/MyST-Parser/pull/481)
    - 🐛 FIX: Ordered list starting number in [483](https://github.com/executablebooks/MyST-Parser/pull/483)
    - 👌 IMPROVE: Propagate enumerated list suffix in [484](https://github.com/executablebooks/MyST-Parser/pull/484)
    - 👌 IMPROVE: `DocutilsRenderer.create_highlighted_code_block` in [488](https://github.com/executablebooks/MyST-Parser/pull/488)
    - 🐛 FIX: Source line reporting for nested parsing in [490](https://github.com/executablebooks/MyST-Parser/pull/490)
    - 🔧 MAINTAIN: Implement `MockInliner.parse` in [504](https://github.com/executablebooks/MyST-Parser/pull/504)
    

    0.16.1

    ✨ NEW: Add `myst_linkify_fuzzy_links` option.
    When using the [`linkify` extension](docs/syntax/optional.mdlinkify), this option can be used to disable matching of links that do not contain a schema (such as `http://`).
    

    0.16.0

    This release contains a number of exciting improvements:
    
    Upgrade of Markdown parser
    
    `markdown-it-py` has been upgraded to [v2.0.0](https://github.com/executablebooks/markdown-it-py/releases/tag/v2.0.0).
    This upgrade brings full compliance with the [CommonMark v0.30 specification](https://spec.commonmark.org/0.30/).
    
    Additionally, `mdit-py-plugins` has been upgraded to [v0.3.0](https://github.com/executablebooks/mdit-py-plugins/releases/tag/v0.3.0).
    This improves the parsing of the MyST target syntax, to allow for spaces and additional special characters in the target name,
    for example this is now valid:
    
    md
    (a bc   |&lt;&gt;*./_-+:)=
    
    Header
    
    
    Also MyST role syntax now supports unlimited length in the role name and new lines in the content.
    For example, this is now valid:
    
    md
    {abc}`xy
    new line`
    
    
    Improvements for Docutils-only use
    
    MyST now allows for Docutils-only use (outside of Sphinx), that allows for MyST configuration options to be set via the `docutils.conf` file, or on the command line.
    
    On installing MyST-Parser, the following CLI-commands are made available:
    
    - `myst-docutils-html`: converts MyST to HTML
    - `myst-docutils-html5`: converts MyST to HTML5
    - `myst-docutils-latex`: converts MyST to LaTeX
    - `myst-docutils-xml`: converts MyST to docutils-native XML
    - `myst-docutils-pseudoxml`: converts MyST to pseudo-XML (to visualise the AST structure)
    
    You can also install the [myst-docutils](https://pypi.org/project/myst-docutils/) package from `pip`,
    which includes no direct install requirements on docutils or sphinx.
    
    See [MyST with Docutils](docs/docutils.md) for more information.
    
    Thanks to help from [cpitclaudel](https://github.com/cpitclaudel)!
    
    Include MyST files in RST files
    
    With `docutils&gt;=0.17`, the `include` directive has a `parser` option.
    This can be used with myst-parser to include MyST files in RST files.
    
    md
    Parse using the docutils only parser:
    
    .. include:: include.md
    :parser: myst_parser.docutils_
    
    Parse using the sphinx parser:
    
    .. include:: include.md
    :parser: myst_parser.sphinx_
    
    
    Addition of the `fieldlist` syntax extension
    
    Field lists are mappings from field names to field bodies, based on the [reStructureText syntax](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists):
    
    rst
    :name only:
    :name: body
    :name:
    Multiple
    
    Paragraphs
    
    
    This should eventually allow for MyST Markdown docstrings! (see &lt;https://github.com/executablebooks/MyST-Parser/issues/228&gt;)
    
    See [Field Lists syntax](docs/syntax/optional.mdfield-lists) for more information.
    
    Improvements to table rendering
    
    Tables with no body are now allowed, for example:
    
    md
    | abc | def |
    | --- | --- |
    
    
    Also cell alignment HTML classes have now been changed to: `text-left`, `text-center`, or `text-right`, for example:
    
    md
    | left | center | right |
    | :--- | :----: | ----: |
    | a    | b      | c     |
    
    
    is converted to:
    
    html
    &lt;table class=&quot;colwidths-auto&quot;&gt;
    &lt;thead&gt;
    &lt;tr&gt;
     &lt;th class=&quot;text-left head&quot;&gt;&lt;p&gt;left&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-center head&quot;&gt;&lt;p&gt;center&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-right head&quot;&gt;&lt;p&gt;right&lt;/p&gt;&lt;/th&gt;
    &lt;/tr&gt;
    &lt;/thead&gt;
    &lt;tbody&gt;
    &lt;tr&gt;
     &lt;td class=&quot;text-left&quot;&gt;&lt;p&gt;a&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-center&quot;&gt;&lt;p&gt;b&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-right&quot;&gt;&lt;p&gt;c&lt;/p&gt;&lt;/td&gt;
    &lt;/tr&gt;
    &lt;/tbody&gt;
    &lt;/table&gt;
    
    
    These classes should be supported by most sphinx HTML themes.
    
    See [Tables syntax](docs/syntax/syntax.mdtables) for more information.
    
    Pull Requests
    
    - 🐛 FIX: Add mandatory attributes on `enumerated_list` by cpitclaudel in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - 📚 DOCS: Add reference to MySTyc in landing page by astrojuanlu in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    - ⬆️ UPGRADE: markdown-it-py v2, mdit-py-plugins v0.3 by chrisjsewell in [449](https://github.com/executablebooks/MyST-Parser/pull/449)
    - 👌 IMPROVE: Table rendering by chrisjsewell in [450](https://github.com/executablebooks/MyST-Parser/pull/450)
    - 🐛 FIX: Ensure parent files are re-built if `include` file changes by chrisjsewell in [451](https://github.com/executablebooks/MyST-Parser/pull/451)
    - 🐛 FIX: Convert empty directive option to `None` by chrisjsewell in [452](https://github.com/executablebooks/MyST-Parser/pull/452)
    - 👌 IMPROVE: Add `\\` for hard-breaks in latex by chrisjsewell in [453](https://github.com/executablebooks/MyST-Parser/pull/453)
    - 🔧 MAINTAIN: Remove empty &quot;sphinx&quot; extra by hukkin in [350](https://github.com/executablebooks/MyST-Parser/pull/350)
    - ✨ NEW: Add `fieldlist` extension by chrisjsewell in [455](https://github.com/executablebooks/MyST-Parser/pull/455)
    - ✨ NEW: Add Docutils MyST config and CLI by cpitclaudel in [426](https://github.com/executablebooks/MyST-Parser/pull/426)
    - 🔧 MAINTAIN: Add publishing job for `myst-docutils` by chrisjsewell in [456](https://github.com/executablebooks/MyST-Parser/pull/456)
    - 🧪 TESTS: Add for `gettext_additional_targets` by jpmckinney in [459](https://github.com/executablebooks/MyST-Parser/pull/459)
    
    New Contributors
    
    - cpitclaudel made their first contribution in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - astrojuanlu made their first contribution in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    
    **Full Changelog**: &lt;https://github.com/executablebooks/MyST-Parser/compare/v0.15.2...v0.16.0&gt;
    

    0.15.2

    This is mainly a maintenance release that fixes some incompatibilities with `sphinx&lt;3.1`, improvements for compatibility
    with `docutils=0.17`, and improvements to robustness.
    

    0.15.1

    👌 IMPROVE: MathJax compatibility with `nbsphinx`
    
    `nbsphinx` also overrides the MathJax configuration.
    For compatibility, `output_area` is added to the list of default processed classes, and the override warning is allowed to be suppressed with `suppress_warnings = [&quot;myst.mathjax&quot;]`.
    

    0.15.0

    Upgraded to `sphinx` v4 ⬆️
    
    A principe change in this release is to updates the requirements of myst-parser from `sphinx&gt;=2,&lt;4` to `sphinx&gt;=3,&lt;5`.
    
    Changed MathJax handling ♻️
    
    Instead of removing all `$` processing for the whole project,
    during MyST document parsing, the top-level section is now given the classes `tex2jax_ignore` and `mathjax_ignore` (turning off default MathJax processing of all HTML elements)
    and MathJax is then configured to process elements with the `tex2jax_process|mathjax_process|math` classes.
    
    See [the math syntax guide](docs/syntax/optional.mdmath-shortcuts) for further information.
    
    Set URL scheme defaults ‼️
    
    The `myst_url_schemes` default is now: `(&quot;http&quot;, &quot;https&quot;, &quot;mailto&quot;, &quot;ftp&quot;)`.
    This means that only these URL will be considered as external (e.g. `[](https://example.com)`),
    and references like `[](prefix:main)` will be considered as internal references.
    Set `myst_url_schemes = None`, to revert to the previous default.
    
    Added `myst_heading_slug_func` option 👌
    
    Use this option to specify a custom function to auto-generate heading anchors (see [Auto-generated header anchors](docs/syntax/optional.mdauto-generated-header-anchors)).
    
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    

    0.13.7

    👌 IMPROVE: Add warning for nested headers:
    
    Nested headers are not supported within most elements (this is a limitation of the docutils/sphinx document structure), and can lead to unexpected outcomes.
    For example in admonitions:
    
    `markdown
    {note}
    Unsupported Header
    
    `
    
    A warning (of type `myst.nested_header`) is now emitted when this occurs.
    
    🔧 MAINTAIN: Python 3.9 is now officially supported.
    

    0.13.6

    🐛 FIX: docutils `v0.17` compatibility
    

    0.13.5

    - ⬆️ UPGRADE: required markdown-it-py to `v0.6.2`:
    In particular, this fixes missing source line mappings for table rows and their children
    - 👌 IMPROVE: Store `rawtext` in AST nodes:
    We now ensure that the raw text is propagated from the Markdown tokens to the Sphinx AST.
    In particular, this is required by the `gettext` builder, to generate translation POT templates.
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    - ✨ NEW: Add warning types `myst.subtype`:
    All parsing warnings are assigned a type/subtype, and also the messages are appended with them.
    These warning types can be suppressed with the sphinx `suppress_warnings` config option.
    See [How-to suppress warnings](howto/warnings) for more information.
    

    0.13.3

    Minor fixes:
    
    - 🐛 FIX: front-matter parsing for bibliographic keys
    - 🐛 FIX: directive/role name translations
    - 👌 IMPROVE: Add warning for multiple footnote definitions
    

    0.13.2

    ✨ NEW: Add `html_admonition` extension
    
    : By adding `&quot;html_admonition&quot;` to `myst_enable_extensions`, you can enable parsing of `&lt;div class=&quot;admonition&quot;&gt;` HTML blocks to sphinx admonitions.
    : This is helpful when you care about viewing the &quot;source&quot; Markdown, such as in Jupyter Notebooks.
    : For example:
    html
    &lt;div class=&quot;admonition note&quot; name=&quot;html-admonition&quot;&gt;
    &lt;p class=&quot;title&quot;&gt;This is the **title**&lt;/p&gt;
    This is the *content*
    &lt;/div&gt;
    
    : See [the optional syntax guide](docs/syntax/optional.md) for further information.
    
    👌 IMPROVE: Footnotes
    
    : If the label is an integer, then it will always use this integer for the rendered label (i.e. they are manually numbered).
    : Add `myst_footnote_transition` configuration, to turn on/off transition line.
    : Add `footnotes` class to transition `&lt;hr&gt;` in HTML.
    : See [the syntax guide](docs/syntax/syntax.md) for further information.
    
    👌 IMPROVE: `substitution` extension logic
    
    : Parse inline substitutions without block rules, unless the substitution starts with a directive.
    
    🐛 FIX: Render front-matter as `field_list`
    
    : To improve use by sphinx extensions).
    
    👌 IMPROVE: Code quality
    
    : Add isort and mypy type checking to code base.
    
    (thanks to contributors akhmerov, tfiers)
    

    0.13.1

    👌 Directives can now be used for inline substitutions, e.g.
    
    md
    ---
    substitutions:
    key: |
     {image} img/fun-fish.png
     :alt: fishy
     :height: 20px
     
    ---
    
    An inline image: {{ key }}
    

    0.13.0

    This release makes some major updates to the optional syntaxes.
    For full details see [Optional MyST Syntaxes](docs/syntax/optional.md).
    
    🗑 Deprecations
    
    `myst_enable_extensions = [&quot;dollarmath&quot;, ...]` now replaces and deprecates individual enable configuration variables: `admonition_enable` -&gt; `&quot;colon_fence&quot;`, `figure_enable` -&gt; `&quot;colon_fence&quot;`, `dmath_enable` -&gt; `&quot;dollarmath&quot;`, `amsmath` -&gt; `&quot;colon_fence&quot;`, `deflist_enable` -&gt; `&quot;deflist&quot;`, `html_img_enable` -&gt; `&quot;html_image&quot;`.
    
    The `colon_fence` extension (replacing `admonition_enable`) now works exactly the same as normal `  ` code fences, but using `:::` delimiters. This is helpful for directives that contain Markdown text, for example:
    
    md
    :::{admonition} The title
    :class: note
    
    This note contains *Markdown*
    :::
    
    
    ✨ New
    
    The `smartquotes` extension will automatically convert standard quotations to their opening/closing variants:
    
    - `&#x27;single quotes&#x27;`: ‘single quotes’
    - `&quot;double quotes&quot;`:  “double quotes”
    
    The `linkify` extension will automatically identify “bare” web URLs, like `www.example.com`,  and add hyperlinks; www.example.com.
    This extension requires that [linkify-it-py](https://github.com/tsutsu3/linkify-it-py) is installed.
    
    The `replacements` extension will automatically convert some common typographic texts, such as `+-` -&gt; `±`.
    
    The `substitution` extension allows you to specify &quot;substitution definitions&quot; in either the `conf.py` (as `myst_substitutions`) and/or individual file&#x27;s front-matter (front-matter takes precedence), which will then replace substitution references. For example:
    
    md
    ---
    substitutions:
    key1: definition
    ---
    {{ key1 }}
    
    
    The substitutions are assessed as [jinja2 expressions](http://jinja.palletsprojects.com/) and includes the [Sphinx Environment](https://www.sphinx-doc.org/en/master/extdev/envapi.html) as `env`, so you can do powerful thinks like:
    
    
    {{ [key1, env.docname] | join(&#x27;/&#x27;) }}
    
    
    The `figure-md` directive has been added (replacing `enable_figure`), which parses a &quot;Markdown friendly&quot; figure (used with the `colon_fence` extension):
    
    md
    :::{figure-md} fig-target
    :class: myclass
    
    &lt;img src=&quot;img/fun-fish.png&quot; alt=&quot;fishy&quot; class=&quot;bg-primary mb-1&quot; width=&quot;200px&quot;&gt;
    
    This is a caption in **Markdown**
    :::
    
    
    👌 Improvements
    
    Using the `html_image` extension, HTML images are now processed for both blocks and (now) inline.
    
    So you can correctly do, for example:
    
    md
    I’m an inline image: &lt;img src=&quot;img/fun-fish.png&quot; height=&quot;20px&quot;&gt;
    
    | table column                              |
    | ----------------------------------------- |
    | &lt;img src=&quot;img/fun-fish.png&quot; width=&quot;20px&quot;&gt; |
    

    0.12.10

    🐛 FIX: allow dates to be parsed in frontmatter.
    : This fixes a bug that would raise errors at parse time if non-string date objects were in front-matter YAML. See [253](https://github.com/executablebooks/MyST-Parser/pull/253)
    

    0.12.9

    ✨ NEW: Auto-generate heading anchors.
    : This utilises `markdown-it-py`&#x27;s `anchors-plugin`, to generate unique anchor &quot;slugs&quot; for each header (up to a certain level),
    and allows them to be referenced *via* a relative path, e.g. `[](./file.mdheader-anchor)`, or in the same document, e.g. `[](header-anchor)`.
    
    Slugs are generated in the GitHub style ([see here](https://github.com/Flet/github-slugger)); lower-case text, removing punctuation, replacing spaces with `-`, enforce uniqueness *via* suffix enumeration `-1`.
    
    It is enabled in your `conf.py` *via* `myst_heading_anchors = 2` (sets maximum heading level).
    
    See [the documentation here](docs/syntax/optional.mdauto-generated-header-anchors).
    
    🐛 FIX: doc reference resolution for singlehtml/latex.
    : These reference resolutions are passed to the &quot;missing-reference&quot; event, and require the `node[&quot;refdoc&quot;]` attribute to be available, which was missing for `[text](./path/to/file.md)` type references.
    

    0.12.7

    ✨ NEW: Want to include your README.md in the documentation?
    : See [including a file from outside the docs folder](howto/include-readme).
    

    0.12.5

    ✨ NEW: Add Markdown figure syntax
    : Setting `myst_figure_enable = True` in your sphinx `conf.py`, combines the above two extended syntaxes,
    to create a fully Markdown compliant version of the `figure` directive.
    See [Markdown Figures](docs/syntax/optional.mdmarkdown-figures) for details.
    

    0.12.4

    👌 IMPROVE: the mathjax extension is now only overridden if strictly necessary (to support dollar and ams math), and the override is more precise, to mitigate any unwanted side-effects
    

    0.12.3

    ✨ NEW: Add definition lists.
    : This addition, enabled by `myst_deflist_enable = True`, allows for &quot;Pandoc style&quot; definition lists to be parsed and rendered, e.g.
    
    md
    Term 1
    : Definition
    
    
    See the [Definition Lists documentation](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists) for further details.
    
    👌 IMPROVE: mathjax_config override.
    : Only `mathjax_config[&quot;tex2jax&quot;]` will now be overridden, in order to not interfere with other user configurations, such as adding TeX macros.
    The configuration name has also changed from `myst_override_mathjax` to `myst_update_mathjax`.
    See [Mathjax and math parsing](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#mathjax-and-math-parsing) for further details.
    

    0.12.2

    ✨ NEW: Add the `eval-rst` directive
    
    : This directive parses its contents as ReStructuredText, which integrates back into the rest of the document, e.g. for cross-referencing. See [this documentation](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#how-directives-parse-content) for further explanation.
    
    In particular, this addition solves some outstanding user requests:
    
    - How-to [include rST files into a Markdown file](https://myst-parser.readthedocs.io/en/latest/using/howto.html#include-rst-files-into-a-markdown-file)
    - How-to [Use sphinx.ext.autodoc in Markdown files](https://myst-parser.readthedocs.io/en/latest/using/howto.html#use-sphinx-ext-autodoc-in-markdown-files)
    
    Thanks to [stephenroller](https://github.com/stephenroller) for the contribution 🎉
    

    0.12.1

    ✨ NEW: Add `myst_commonmark_only` config option, for restricting the parser to strict CommonMark (no extensions).
    

    0.12.0

    ‼️ BREAKING
    
    If you are using math in your documents, be sure to read the updated [Math syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#math-shortcuts)!
    In particular, the Mathjax configuration is now overridden, such that LaTeX environments will only be rendered if `myst_amsmath_enable=True` is set.
    
    The `myst_math_delimiters` option has also been removed (please open an issue if you would like brackets math parsing to be re-implemented).
    
    In addition the `myst_html_img` option name has been changed to `myst_html_img_enable`.
    
    Some underlying code has also been refactored, to centralise handling of configuration options (see [commit 98573b9](https://github.com/executablebooks/MyST-Parser/commit/98573b9c6e3602ab31d627b5266ae5c1ba2c9e5f)).
    
    Improved 👌
    
    More configuration options for math parsing (see [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)).
    

    0.11.2

    Added ✨
    
    - `&lt;img src=&quot;file.png&quot; width=&quot;200px&quot;&gt;` tag parsing to sphinx representation, see [the image syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#images)
    
    Improved 👌
    
    - `[title](link)` syntax now works with intersphinx references.
    Recognised URI schemas can also be configured, see the [configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)
    

    0.11.1

    Fix
    
    - Correctly pin required minimum markdown-it-py version
    

    0.11.0

    Added ✨
    
    * Special admonition directive syntax (optional):
    
    md
    :::{note}
    This text is **standard** _Markdown_
    :::
    
    
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#admonition-directives-special-syntax-optional) for details.
    
    * Direct parsing of [amsmath](https://ctan.org/pkg/amsmath) LaTeX equations (optional).
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#direct-latex-math-optional) for details.
    
    Breaking ‼️
    
    * Sphinx configuration options are now set as separate variables, rather than a single dict.
    See [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options) for details.
    

    0.10.0

    ([full changelog](https://github.com/executablebooks/MyST-Parser/compare/v0.9.1...aaed58808af485c29bbbf73c5aac10697bfa08b9))
    
    Improved 👌
    
    * Support Sphinx version 3 [197](https://github.com/executablebooks/MyST-Parser/pull/197) ([chrisjsewell](https://github.com/chrisjsewell))
    * Update Trove Classifiers [192](https://github.com/executablebooks/MyST-Parser/pull/192) ([chrisjsewell](https://github.com/chrisjsewell))
    * Add functionality to use docutils specialized role [189](https://github.com/executablebooks/MyST-Parser/pull/189) ([chrisjsewell](https://github.com/chrisjsewell))
    
    Contributors to this release
    
    ([GitHub contributors page for this release](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-07-20&amp;to=2020-08-07&amp;type=c))
    
    [AakashGfude](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3AAakashGfude+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [welcome](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awelcome+updated%3A2020-07-20..2020-08-07&amp;type=Issues)
    
    Past Releases
    
    Contributors
    
    ([GitHub contributors page for these releases](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-01-01&amp;to=2020-07-20&amp;type=c))
    
    [akhmerov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aakhmerov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [certik](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acertik+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [dhermes](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Adhermes+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [filippo82](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Afilippo82+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jlperla](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajlperla+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jstac](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajstac+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [martinagvilas](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amartinagvilas+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mlncn](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amlncn+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mmcky](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ammcky+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [moorepants](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amoorepants+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [najuzilu](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anajuzilu+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [nathancarter](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anathancarter+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [pauleveritt](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Apauleveritt+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [phaustin](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aphaustin+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rossbar](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arossbar+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rowanc1](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arowanc1+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [sbliven](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Asbliven+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-01-01..2020-07-20&amp;type=Issues)
    
    Links
    • PyPI: https://pypi.org/project/myst-parser
    • Changelog: https://pyup.io/changelogs/myst-parser/
    • Repo: https://github.com/executablebooks/MyST-Parser

    Update pytest from 7.0.0 to 7.0.1.

    Changelog

    7.0.1

    =========================
    
    Bug Fixes
    ---------
    
    - `9608 &lt;https://github.com/pytest-dev/pytest/issues/9608&gt;`_: Fix invalid importing of ``importlib.readers`` in Python 3.9.
    
    
    - `9610 &lt;https://github.com/pytest-dev/pytest/issues/9610&gt;`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method.
    Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`.
    Regressed in pytest 7.0.0.
    
    
    - `9636 &lt;https://github.com/pytest-dev/pytest/issues/9636&gt;`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin.
    
    
    - `9642 &lt;https://github.com/pytest-dev/pytest/issues/9642&gt;`_: Fix running tests by id with ``::`` in the parametrize portion.
    
    
    - `9643 &lt;https://github.com/pytest-dev/pytest/issues/9643&gt;`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and
    :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters &lt;warnings&gt;`.
    
    Links
    • PyPI: https://pypi.org/project/pytest
    • Changelog: https://pyup.io/changelogs/pytest/
    • Homepage: https://docs.pytest.org/en/latest/
    update 
    opened by pyup-bot 1
  • Bug #12345 Scheduled daily dependency update on Sunday

    Bug #12345 Scheduled daily dependency update on Sunday

    Update secretum_sphinx_theme from 2022.1 to 2022.1.

    The bot wasn't able to find a changelog for this release. Got an idea?

    Links
    • PyPI: https://pypi.org/project/secretum-sphinx-theme
    • Repo: https://github.com/secretum-inc/secretum_sphinx_theme/archive/v2022.1.tar.gz

    Update myst_parser from 0.17.0 to 0.17.0.

    Changelog

    0.17.0

    This release contains a number of breaking improvements.
    
    Full Changelog: [v0.16.1...v0.17.0](https://github.com/executablebooks/MyST-Parser/compare/v0.16.1...v0.17.0)
    
    ‼️ Markdown link resolution improvements
    
    Markdown links are of the format `[text](link)`.
    MyST-Parser looks to smartly resolve such links, by identifying if they are:
    
    1. A link to an external resource, e.g. `[text](http://example.com)`
    2. A link to another source document, e.g. `[text](file.md)`
    - If `header-anchors` are enabled, anchor links are also supported, e.g. `[text](file.mdanchor)`
    3. A link to an internal sphinx cross-reference, e.g. `[text](my-reference)`
    
    an additional situation is now supported:
    
    4. A link to a source file, which is not a document, e.g. `[text](file.js)`. This behaves similarly to the sphinx `download` role.
    
    In addition, configuration to more finely tune this behaviour has been added.
    
    - `myst_all_links_external=True`, will make all links be treated as (1)
    - `myst_url_schemes=(&quot;http&quot;, &quot;https&quot;)`, sets what URL schemes are treated as (1)
    - `myst_ref_domains=(&quot;std&quot;, &quot;py&quot;)`, sets what Sphinx reference domains are checked, when handling (3)
    
    See [Markdown Links and Referencing](docs/syntax/syntax.mdmarkdown-links-and-referencing) for more information.
    
    ‼️ Dollarmath is now disabled by default
    
    The default configuration is now `myst_enable_extensions=()`, instead of `myst_enable_extensions=(&quot;dollarmath&quot;,)`.
    If you are using math enclosed in `$` or `$$` in your documents, you should enable `dollarmath` explicitly.
    
    See [Dollar delimited math](docs/syntax/optional.mdmath-shortcuts) for more information.
    
    ⬆️ Drop Python 3.6 support
    
    MyST-Parser now supports, and is tested against, Python 3.7 to 3.10.
    
    ✨ Add the `strikethrough` extension and `myst_gfm_only` configuration
    
    The `strikethrough` extension allows text within `~~` delimiters to have a strike-through (horizontal line) placed over it.
    For example, `~~strikethrough with *emphasis*~~` renders as: ~~strikethrough with *emphasis*~~.
    
    **Important**: This extension is currently only supported for HTML output.
    
    See [Strikethrough](docs/syntax/optional.mdstrikethrough) for more information.
    
    The `myst_gfm_only=True` configuration sets up specific configuration, to enable compliance only with [GitHub-flavored Markdown](https://github.github.com/gfm/), including enabling the `strikethrough`, `tasklist` and `linkify` extensions, but disabling support for roles and directives.
    
    ✨ Add `myst_title_to_header` configuration
    
    Setting `myst_title_to_header=True`, allows for a `title` key in the frontmatter to be used as the document title.
    for example:
    
    md
    ---
    title: My Title with *emphasis*
    ---
    
    
    would be equivalent to:
    
    md
    My Title with *emphasis*
    
    
    See [Front matter](docs/syntax/syntax.mdfront-matter) for more information.
    
    👌 Internal improvements
    
    👌 IMPROVE: Convert nested headings to rubrics.
    Headings within directives are not directly supported by sphinx, since they break the structure of the document. Previously myst-parser would emit a `myst.nested_header` warning, but still generate the heading, leading to unexpected outcomes.
    Now the warning is still emitted, but also the heading is rendered as a [rubric](https://docutils.sourceforge.io/docs/ref/rst/directives.html#rubric) non-structural heading (i.e. it will not show in the ToC).
    
    Other internal improvements primarily focussed in improving support for the for &quot;docutils-only&quot; use, introduced in `v0.16`:
    
    - ♻️ REFACTOR: `default_parser` -&gt; `create_md_parser` in [474](https://github.com/executablebooks/MyST-Parser/pull/474)
    - 👌 IMPROVE: Add `bullet` attribute to `bullet_list` node in [465](https://github.com/executablebooks/MyST-Parser/pull/465)
    - 👌 IMPROVE: Use correct renderer for `state.inline_text` in [466](https://github.com/executablebooks/MyST-Parser/pull/466)
    - 👌 IMPROVE: Docutils parser settings in [476](https://github.com/executablebooks/MyST-Parser/pull/476)
    - 🐛 FIX: front-matter rendering with docutils in [477](https://github.com/executablebooks/MyST-Parser/pull/477)
    - 👌 IMPROVE: Code block highlighting in [478](https://github.com/executablebooks/MyST-Parser/pull/478)
    - 👌 IMPROVE: `note_refname` for docutils internal links in [481](https://github.com/executablebooks/MyST-Parser/pull/481)
    - 🐛 FIX: Ordered list starting number in [483](https://github.com/executablebooks/MyST-Parser/pull/483)
    - 👌 IMPROVE: Propagate enumerated list suffix in [484](https://github.com/executablebooks/MyST-Parser/pull/484)
    - 👌 IMPROVE: `DocutilsRenderer.create_highlighted_code_block` in [488](https://github.com/executablebooks/MyST-Parser/pull/488)
    - 🐛 FIX: Source line reporting for nested parsing in [490](https://github.com/executablebooks/MyST-Parser/pull/490)
    - 🔧 MAINTAIN: Implement `MockInliner.parse` in [504](https://github.com/executablebooks/MyST-Parser/pull/504)
    

    0.16.1

    ✨ NEW: Add `myst_linkify_fuzzy_links` option.
    When using the [`linkify` extension](docs/syntax/optional.mdlinkify), this option can be used to disable matching of links that do not contain a schema (such as `http://`).
    

    0.16.0

    This release contains a number of exciting improvements:
    
    Upgrade of Markdown parser
    
    `markdown-it-py` has been upgraded to [v2.0.0](https://github.com/executablebooks/markdown-it-py/releases/tag/v2.0.0).
    This upgrade brings full compliance with the [CommonMark v0.30 specification](https://spec.commonmark.org/0.30/).
    
    Additionally, `mdit-py-plugins` has been upgraded to [v0.3.0](https://github.com/executablebooks/mdit-py-plugins/releases/tag/v0.3.0).
    This improves the parsing of the MyST target syntax, to allow for spaces and additional special characters in the target name,
    for example this is now valid:
    
    md
    (a bc   |&lt;&gt;*./_-+:)=
    
    Header
    
    
    Also MyST role syntax now supports unlimited length in the role name and new lines in the content.
    For example, this is now valid:
    
    md
    {abc}`xy
    new line`
    
    
    Improvements for Docutils-only use
    
    MyST now allows for Docutils-only use (outside of Sphinx), that allows for MyST configuration options to be set via the `docutils.conf` file, or on the command line.
    
    On installing MyST-Parser, the following CLI-commands are made available:
    
    - `myst-docutils-html`: converts MyST to HTML
    - `myst-docutils-html5`: converts MyST to HTML5
    - `myst-docutils-latex`: converts MyST to LaTeX
    - `myst-docutils-xml`: converts MyST to docutils-native XML
    - `myst-docutils-pseudoxml`: converts MyST to pseudo-XML (to visualise the AST structure)
    
    You can also install the [myst-docutils](https://pypi.org/project/myst-docutils/) package from `pip`,
    which includes no direct install requirements on docutils or sphinx.
    
    See [MyST with Docutils](docs/docutils.md) for more information.
    
    Thanks to help from [cpitclaudel](https://github.com/cpitclaudel)!
    
    Include MyST files in RST files
    
    With `docutils&gt;=0.17`, the `include` directive has a `parser` option.
    This can be used with myst-parser to include MyST files in RST files.
    
    md
    Parse using the docutils only parser:
    
    .. include:: include.md
    :parser: myst_parser.docutils_
    
    Parse using the sphinx parser:
    
    .. include:: include.md
    :parser: myst_parser.sphinx_
    
    
    Addition of the `fieldlist` syntax extension
    
    Field lists are mappings from field names to field bodies, based on the [reStructureText syntax](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists):
    
    rst
    :name only:
    :name: body
    :name:
    Multiple
    
    Paragraphs
    
    
    This should eventually allow for MyST Markdown docstrings! (see &lt;https://github.com/executablebooks/MyST-Parser/issues/228&gt;)
    
    See [Field Lists syntax](docs/syntax/optional.mdfield-lists) for more information.
    
    Improvements to table rendering
    
    Tables with no body are now allowed, for example:
    
    md
    | abc | def |
    | --- | --- |
    
    
    Also cell alignment HTML classes have now been changed to: `text-left`, `text-center`, or `text-right`, for example:
    
    md
    | left | center | right |
    | :--- | :----: | ----: |
    | a    | b      | c     |
    
    
    is converted to:
    
    html
    &lt;table class=&quot;colwidths-auto&quot;&gt;
    &lt;thead&gt;
    &lt;tr&gt;
     &lt;th class=&quot;text-left head&quot;&gt;&lt;p&gt;left&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-center head&quot;&gt;&lt;p&gt;center&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-right head&quot;&gt;&lt;p&gt;right&lt;/p&gt;&lt;/th&gt;
    &lt;/tr&gt;
    &lt;/thead&gt;
    &lt;tbody&gt;
    &lt;tr&gt;
     &lt;td class=&quot;text-left&quot;&gt;&lt;p&gt;a&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-center&quot;&gt;&lt;p&gt;b&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-right&quot;&gt;&lt;p&gt;c&lt;/p&gt;&lt;/td&gt;
    &lt;/tr&gt;
    &lt;/tbody&gt;
    &lt;/table&gt;
    
    
    These classes should be supported by most sphinx HTML themes.
    
    See [Tables syntax](docs/syntax/syntax.mdtables) for more information.
    
    Pull Requests
    
    - 🐛 FIX: Add mandatory attributes on `enumerated_list` by cpitclaudel in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - 📚 DOCS: Add reference to MySTyc in landing page by astrojuanlu in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    - ⬆️ UPGRADE: markdown-it-py v2, mdit-py-plugins v0.3 by chrisjsewell in [449](https://github.com/executablebooks/MyST-Parser/pull/449)
    - 👌 IMPROVE: Table rendering by chrisjsewell in [450](https://github.com/executablebooks/MyST-Parser/pull/450)
    - 🐛 FIX: Ensure parent files are re-built if `include` file changes by chrisjsewell in [451](https://github.com/executablebooks/MyST-Parser/pull/451)
    - 🐛 FIX: Convert empty directive option to `None` by chrisjsewell in [452](https://github.com/executablebooks/MyST-Parser/pull/452)
    - 👌 IMPROVE: Add `\\` for hard-breaks in latex by chrisjsewell in [453](https://github.com/executablebooks/MyST-Parser/pull/453)
    - 🔧 MAINTAIN: Remove empty &quot;sphinx&quot; extra by hukkin in [350](https://github.com/executablebooks/MyST-Parser/pull/350)
    - ✨ NEW: Add `fieldlist` extension by chrisjsewell in [455](https://github.com/executablebooks/MyST-Parser/pull/455)
    - ✨ NEW: Add Docutils MyST config and CLI by cpitclaudel in [426](https://github.com/executablebooks/MyST-Parser/pull/426)
    - 🔧 MAINTAIN: Add publishing job for `myst-docutils` by chrisjsewell in [456](https://github.com/executablebooks/MyST-Parser/pull/456)
    - 🧪 TESTS: Add for `gettext_additional_targets` by jpmckinney in [459](https://github.com/executablebooks/MyST-Parser/pull/459)
    
    New Contributors
    
    - cpitclaudel made their first contribution in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - astrojuanlu made their first contribution in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    
    **Full Changelog**: &lt;https://github.com/executablebooks/MyST-Parser/compare/v0.15.2...v0.16.0&gt;
    

    0.15.2

    This is mainly a maintenance release that fixes some incompatibilities with `sphinx&lt;3.1`, improvements for compatibility
    with `docutils=0.17`, and improvements to robustness.
    

    0.15.1

    👌 IMPROVE: MathJax compatibility with `nbsphinx`
    
    `nbsphinx` also overrides the MathJax configuration.
    For compatibility, `output_area` is added to the list of default processed classes, and the override warning is allowed to be suppressed with `suppress_warnings = [&quot;myst.mathjax&quot;]`.
    

    0.15.0

    Upgraded to `sphinx` v4 ⬆️
    
    A principe change in this release is to updates the requirements of myst-parser from `sphinx&gt;=2,&lt;4` to `sphinx&gt;=3,&lt;5`.
    
    Changed MathJax handling ♻️
    
    Instead of removing all `$` processing for the whole project,
    during MyST document parsing, the top-level section is now given the classes `tex2jax_ignore` and `mathjax_ignore` (turning off default MathJax processing of all HTML elements)
    and MathJax is then configured to process elements with the `tex2jax_process|mathjax_process|math` classes.
    
    See [the math syntax guide](docs/syntax/optional.mdmath-shortcuts) for further information.
    
    Set URL scheme defaults ‼️
    
    The `myst_url_schemes` default is now: `(&quot;http&quot;, &quot;https&quot;, &quot;mailto&quot;, &quot;ftp&quot;)`.
    This means that only these URL will be considered as external (e.g. `[](https://example.com)`),
    and references like `[](prefix:main)` will be considered as internal references.
    Set `myst_url_schemes = None`, to revert to the previous default.
    
    Added `myst_heading_slug_func` option 👌
    
    Use this option to specify a custom function to auto-generate heading anchors (see [Auto-generated header anchors](docs/syntax/optional.mdauto-generated-header-anchors)).
    
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    

    0.13.7

    👌 IMPROVE: Add warning for nested headers:
    
    Nested headers are not supported within most elements (this is a limitation of the docutils/sphinx document structure), and can lead to unexpected outcomes.
    For example in admonitions:
    
    `markdown
    {note}
    Unsupported Header
    
    `
    
    A warning (of type `myst.nested_header`) is now emitted when this occurs.
    
    🔧 MAINTAIN: Python 3.9 is now officially supported.
    

    0.13.6

    🐛 FIX: docutils `v0.17` compatibility
    

    0.13.5

    - ⬆️ UPGRADE: required markdown-it-py to `v0.6.2`:
    In particular, this fixes missing source line mappings for table rows and their children
    - 👌 IMPROVE: Store `rawtext` in AST nodes:
    We now ensure that the raw text is propagated from the Markdown tokens to the Sphinx AST.
    In particular, this is required by the `gettext` builder, to generate translation POT templates.
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    - ✨ NEW: Add warning types `myst.subtype`:
    All parsing warnings are assigned a type/subtype, and also the messages are appended with them.
    These warning types can be suppressed with the sphinx `suppress_warnings` config option.
    See [How-to suppress warnings](howto/warnings) for more information.
    

    0.13.3

    Minor fixes:
    
    - 🐛 FIX: front-matter parsing for bibliographic keys
    - 🐛 FIX: directive/role name translations
    - 👌 IMPROVE: Add warning for multiple footnote definitions
    

    0.13.2

    ✨ NEW: Add `html_admonition` extension
    
    : By adding `&quot;html_admonition&quot;` to `myst_enable_extensions`, you can enable parsing of `&lt;div class=&quot;admonition&quot;&gt;` HTML blocks to sphinx admonitions.
    : This is helpful when you care about viewing the &quot;source&quot; Markdown, such as in Jupyter Notebooks.
    : For example:
    html
    &lt;div class=&quot;admonition note&quot; name=&quot;html-admonition&quot;&gt;
    &lt;p class=&quot;title&quot;&gt;This is the **title**&lt;/p&gt;
    This is the *content*
    &lt;/div&gt;
    
    : See [the optional syntax guide](docs/syntax/optional.md) for further information.
    
    👌 IMPROVE: Footnotes
    
    : If the label is an integer, then it will always use this integer for the rendered label (i.e. they are manually numbered).
    : Add `myst_footnote_transition` configuration, to turn on/off transition line.
    : Add `footnotes` class to transition `&lt;hr&gt;` in HTML.
    : See [the syntax guide](docs/syntax/syntax.md) for further information.
    
    👌 IMPROVE: `substitution` extension logic
    
    : Parse inline substitutions without block rules, unless the substitution starts with a directive.
    
    🐛 FIX: Render front-matter as `field_list`
    
    : To improve use by sphinx extensions).
    
    👌 IMPROVE: Code quality
    
    : Add isort and mypy type checking to code base.
    
    (thanks to contributors akhmerov, tfiers)
    

    0.13.1

    👌 Directives can now be used for inline substitutions, e.g.
    
    md
    ---
    substitutions:
    key: |
     {image} img/fun-fish.png
     :alt: fishy
     :height: 20px
     
    ---
    
    An inline image: {{ key }}
    

    0.13.0

    This release makes some major updates to the optional syntaxes.
    For full details see [Optional MyST Syntaxes](docs/syntax/optional.md).
    
    🗑 Deprecations
    
    `myst_enable_extensions = [&quot;dollarmath&quot;, ...]` now replaces and deprecates individual enable configuration variables: `admonition_enable` -&gt; `&quot;colon_fence&quot;`, `figure_enable` -&gt; `&quot;colon_fence&quot;`, `dmath_enable` -&gt; `&quot;dollarmath&quot;`, `amsmath` -&gt; `&quot;colon_fence&quot;`, `deflist_enable` -&gt; `&quot;deflist&quot;`, `html_img_enable` -&gt; `&quot;html_image&quot;`.
    
    The `colon_fence` extension (replacing `admonition_enable`) now works exactly the same as normal `  ` code fences, but using `:::` delimiters. This is helpful for directives that contain Markdown text, for example:
    
    md
    :::{admonition} The title
    :class: note
    
    This note contains *Markdown*
    :::
    
    
    ✨ New
    
    The `smartquotes` extension will automatically convert standard quotations to their opening/closing variants:
    
    - `&#x27;single quotes&#x27;`: ‘single quotes’
    - `&quot;double quotes&quot;`:  “double quotes”
    
    The `linkify` extension will automatically identify “bare” web URLs, like `www.example.com`,  and add hyperlinks; www.example.com.
    This extension requires that [linkify-it-py](https://github.com/tsutsu3/linkify-it-py) is installed.
    
    The `replacements` extension will automatically convert some common typographic texts, such as `+-` -&gt; `±`.
    
    The `substitution` extension allows you to specify &quot;substitution definitions&quot; in either the `conf.py` (as `myst_substitutions`) and/or individual file&#x27;s front-matter (front-matter takes precedence), which will then replace substitution references. For example:
    
    md
    ---
    substitutions:
    key1: definition
    ---
    {{ key1 }}
    
    
    The substitutions are assessed as [jinja2 expressions](http://jinja.palletsprojects.com/) and includes the [Sphinx Environment](https://www.sphinx-doc.org/en/master/extdev/envapi.html) as `env`, so you can do powerful thinks like:
    
    
    {{ [key1, env.docname] | join(&#x27;/&#x27;) }}
    
    
    The `figure-md` directive has been added (replacing `enable_figure`), which parses a &quot;Markdown friendly&quot; figure (used with the `colon_fence` extension):
    
    md
    :::{figure-md} fig-target
    :class: myclass
    
    &lt;img src=&quot;img/fun-fish.png&quot; alt=&quot;fishy&quot; class=&quot;bg-primary mb-1&quot; width=&quot;200px&quot;&gt;
    
    This is a caption in **Markdown**
    :::
    
    
    👌 Improvements
    
    Using the `html_image` extension, HTML images are now processed for both blocks and (now) inline.
    
    So you can correctly do, for example:
    
    md
    I’m an inline image: &lt;img src=&quot;img/fun-fish.png&quot; height=&quot;20px&quot;&gt;
    
    | table column                              |
    | ----------------------------------------- |
    | &lt;img src=&quot;img/fun-fish.png&quot; width=&quot;20px&quot;&gt; |
    

    0.12.10

    🐛 FIX: allow dates to be parsed in frontmatter.
    : This fixes a bug that would raise errors at parse time if non-string date objects were in front-matter YAML. See [253](https://github.com/executablebooks/MyST-Parser/pull/253)
    

    0.12.9

    ✨ NEW: Auto-generate heading anchors.
    : This utilises `markdown-it-py`&#x27;s `anchors-plugin`, to generate unique anchor &quot;slugs&quot; for each header (up to a certain level),
    and allows them to be referenced *via* a relative path, e.g. `[](./file.mdheader-anchor)`, or in the same document, e.g. `[](header-anchor)`.
    
    Slugs are generated in the GitHub style ([see here](https://github.com/Flet/github-slugger)); lower-case text, removing punctuation, replacing spaces with `-`, enforce uniqueness *via* suffix enumeration `-1`.
    
    It is enabled in your `conf.py` *via* `myst_heading_anchors = 2` (sets maximum heading level).
    
    See [the documentation here](docs/syntax/optional.mdauto-generated-header-anchors).
    
    🐛 FIX: doc reference resolution for singlehtml/latex.
    : These reference resolutions are passed to the &quot;missing-reference&quot; event, and require the `node[&quot;refdoc&quot;]` attribute to be available, which was missing for `[text](./path/to/file.md)` type references.
    

    0.12.7

    ✨ NEW: Want to include your README.md in the documentation?
    : See [including a file from outside the docs folder](howto/include-readme).
    

    0.12.5

    ✨ NEW: Add Markdown figure syntax
    : Setting `myst_figure_enable = True` in your sphinx `conf.py`, combines the above two extended syntaxes,
    to create a fully Markdown compliant version of the `figure` directive.
    See [Markdown Figures](docs/syntax/optional.mdmarkdown-figures) for details.
    

    0.12.4

    👌 IMPROVE: the mathjax extension is now only overridden if strictly necessary (to support dollar and ams math), and the override is more precise, to mitigate any unwanted side-effects
    

    0.12.3

    ✨ NEW: Add definition lists.
    : This addition, enabled by `myst_deflist_enable = True`, allows for &quot;Pandoc style&quot; definition lists to be parsed and rendered, e.g.
    
    md
    Term 1
    : Definition
    
    
    See the [Definition Lists documentation](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists) for further details.
    
    👌 IMPROVE: mathjax_config override.
    : Only `mathjax_config[&quot;tex2jax&quot;]` will now be overridden, in order to not interfere with other user configurations, such as adding TeX macros.
    The configuration name has also changed from `myst_override_mathjax` to `myst_update_mathjax`.
    See [Mathjax and math parsing](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#mathjax-and-math-parsing) for further details.
    

    0.12.2

    ✨ NEW: Add the `eval-rst` directive
    
    : This directive parses its contents as ReStructuredText, which integrates back into the rest of the document, e.g. for cross-referencing. See [this documentation](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#how-directives-parse-content) for further explanation.
    
    In particular, this addition solves some outstanding user requests:
    
    - How-to [include rST files into a Markdown file](https://myst-parser.readthedocs.io/en/latest/using/howto.html#include-rst-files-into-a-markdown-file)
    - How-to [Use sphinx.ext.autodoc in Markdown files](https://myst-parser.readthedocs.io/en/latest/using/howto.html#use-sphinx-ext-autodoc-in-markdown-files)
    
    Thanks to [stephenroller](https://github.com/stephenroller) for the contribution 🎉
    

    0.12.1

    ✨ NEW: Add `myst_commonmark_only` config option, for restricting the parser to strict CommonMark (no extensions).
    

    0.12.0

    ‼️ BREAKING
    
    If you are using math in your documents, be sure to read the updated [Math syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#math-shortcuts)!
    In particular, the Mathjax configuration is now overridden, such that LaTeX environments will only be rendered if `myst_amsmath_enable=True` is set.
    
    The `myst_math_delimiters` option has also been removed (please open an issue if you would like brackets math parsing to be re-implemented).
    
    In addition the `myst_html_img` option name has been changed to `myst_html_img_enable`.
    
    Some underlying code has also been refactored, to centralise handling of configuration options (see [commit 98573b9](https://github.com/executablebooks/MyST-Parser/commit/98573b9c6e3602ab31d627b5266ae5c1ba2c9e5f)).
    
    Improved 👌
    
    More configuration options for math parsing (see [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)).
    

    0.11.2

    Added ✨
    
    - `&lt;img src=&quot;file.png&quot; width=&quot;200px&quot;&gt;` tag parsing to sphinx representation, see [the image syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#images)
    
    Improved 👌
    
    - `[title](link)` syntax now works with intersphinx references.
    Recognised URI schemas can also be configured, see the [configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)
    

    0.11.1

    Fix
    
    - Correctly pin required minimum markdown-it-py version
    

    0.11.0

    Added ✨
    
    * Special admonition directive syntax (optional):
    
    md
    :::{note}
    This text is **standard** _Markdown_
    :::
    
    
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#admonition-directives-special-syntax-optional) for details.
    
    * Direct parsing of [amsmath](https://ctan.org/pkg/amsmath) LaTeX equations (optional).
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#direct-latex-math-optional) for details.
    
    Breaking ‼️
    
    * Sphinx configuration options are now set as separate variables, rather than a single dict.
    See [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options) for details.
    

    0.10.0

    ([full changelog](https://github.com/executablebooks/MyST-Parser/compare/v0.9.1...aaed58808af485c29bbbf73c5aac10697bfa08b9))
    
    Improved 👌
    
    * Support Sphinx version 3 [197](https://github.com/executablebooks/MyST-Parser/pull/197) ([chrisjsewell](https://github.com/chrisjsewell))
    * Update Trove Classifiers [192](https://github.com/executablebooks/MyST-Parser/pull/192) ([chrisjsewell](https://github.com/chrisjsewell))
    * Add functionality to use docutils specialized role [189](https://github.com/executablebooks/MyST-Parser/pull/189) ([chrisjsewell](https://github.com/chrisjsewell))
    
    Contributors to this release
    
    ([GitHub contributors page for this release](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-07-20&amp;to=2020-08-07&amp;type=c))
    
    [AakashGfude](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3AAakashGfude+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [welcome](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awelcome+updated%3A2020-07-20..2020-08-07&amp;type=Issues)
    
    Past Releases
    
    Contributors
    
    ([GitHub contributors page for these releases](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-01-01&amp;to=2020-07-20&amp;type=c))
    
    [akhmerov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aakhmerov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [certik](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acertik+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [dhermes](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Adhermes+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [filippo82](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Afilippo82+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jlperla](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajlperla+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jstac](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajstac+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [martinagvilas](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amartinagvilas+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mlncn](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amlncn+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mmcky](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ammcky+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [moorepants](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amoorepants+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [najuzilu](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anajuzilu+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [nathancarter](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anathancarter+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [pauleveritt](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Apauleveritt+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [phaustin](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aphaustin+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rossbar](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arossbar+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rowanc1](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arowanc1+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [sbliven](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Asbliven+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-01-01..2020-07-20&amp;type=Issues)
    
    Links
    • PyPI: https://pypi.org/project/myst-parser
    • Changelog: https://pyup.io/changelogs/myst-parser/
    • Repo: https://github.com/executablebooks/MyST-Parser

    Update pytest from 7.0.0 to 7.0.1.

    Changelog

    7.0.1

    =========================
    
    Bug Fixes
    ---------
    
    - `9608 &lt;https://github.com/pytest-dev/pytest/issues/9608&gt;`_: Fix invalid importing of ``importlib.readers`` in Python 3.9.
    
    
    - `9610 &lt;https://github.com/pytest-dev/pytest/issues/9610&gt;`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method.
    Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`.
    Regressed in pytest 7.0.0.
    
    
    - `9636 &lt;https://github.com/pytest-dev/pytest/issues/9636&gt;`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin.
    
    
    - `9642 &lt;https://github.com/pytest-dev/pytest/issues/9642&gt;`_: Fix running tests by id with ``::`` in the parametrize portion.
    
    
    - `9643 &lt;https://github.com/pytest-dev/pytest/issues/9643&gt;`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and
    :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters &lt;warnings&gt;`.
    
    Links
    • PyPI: https://pypi.org/project/pytest
    • Changelog: https://pyup.io/changelogs/pytest/
    • Homepage: https://docs.pytest.org/en/latest/
    update 
    opened by pyup-bot 1
  • Bug #12345 Scheduled daily dependency update on Saturday

    Bug #12345 Scheduled daily dependency update on Saturday

    Update secretum_sphinx_theme from 2022.1 to 2022.1.

    The bot wasn't able to find a changelog for this release. Got an idea?

    Links
    • PyPI: https://pypi.org/project/secretum-sphinx-theme
    • Repo: https://github.com/secretum-inc/secretum_sphinx_theme/archive/v2022.1.tar.gz

    Update myst_parser from 0.17.0 to 0.17.0.

    Changelog

    0.17.0

    This release contains a number of breaking improvements.
    
    Full Changelog: [v0.16.1...v0.17.0](https://github.com/executablebooks/MyST-Parser/compare/v0.16.1...v0.17.0)
    
    ‼️ Markdown link resolution improvements
    
    Markdown links are of the format `[text](link)`.
    MyST-Parser looks to smartly resolve such links, by identifying if they are:
    
    1. A link to an external resource, e.g. `[text](http://example.com)`
    2. A link to another source document, e.g. `[text](file.md)`
    - If `header-anchors` are enabled, anchor links are also supported, e.g. `[text](file.mdanchor)`
    3. A link to an internal sphinx cross-reference, e.g. `[text](my-reference)`
    
    an additional situation is now supported:
    
    4. A link to a source file, which is not a document, e.g. `[text](file.js)`. This behaves similarly to the sphinx `download` role.
    
    In addition, configuration to more finely tune this behaviour has been added.
    
    - `myst_all_links_external=True`, will make all links be treated as (1)
    - `myst_url_schemes=(&quot;http&quot;, &quot;https&quot;)`, sets what URL schemes are treated as (1)
    - `myst_ref_domains=(&quot;std&quot;, &quot;py&quot;)`, sets what Sphinx reference domains are checked, when handling (3)
    
    See [Markdown Links and Referencing](docs/syntax/syntax.mdmarkdown-links-and-referencing) for more information.
    
    ‼️ Dollarmath is now disabled by default
    
    The default configuration is now `myst_enable_extensions=()`, instead of `myst_enable_extensions=(&quot;dollarmath&quot;,)`.
    If you are using math enclosed in `$` or `$$` in your documents, you should enable `dollarmath` explicitly.
    
    See [Dollar delimited math](docs/syntax/optional.mdmath-shortcuts) for more information.
    
    ⬆️ Drop Python 3.6 support
    
    MyST-Parser now supports, and is tested against, Python 3.7 to 3.10.
    
    ✨ Add the `strikethrough` extension and `myst_gfm_only` configuration
    
    The `strikethrough` extension allows text within `~~` delimiters to have a strike-through (horizontal line) placed over it.
    For example, `~~strikethrough with *emphasis*~~` renders as: ~~strikethrough with *emphasis*~~.
    
    **Important**: This extension is currently only supported for HTML output.
    
    See [Strikethrough](docs/syntax/optional.mdstrikethrough) for more information.
    
    The `myst_gfm_only=True` configuration sets up specific configuration, to enable compliance only with [GitHub-flavored Markdown](https://github.github.com/gfm/), including enabling the `strikethrough`, `tasklist` and `linkify` extensions, but disabling support for roles and directives.
    
    ✨ Add `myst_title_to_header` configuration
    
    Setting `myst_title_to_header=True`, allows for a `title` key in the frontmatter to be used as the document title.
    for example:
    
    md
    ---
    title: My Title with *emphasis*
    ---
    
    
    would be equivalent to:
    
    md
    My Title with *emphasis*
    
    
    See [Front matter](docs/syntax/syntax.mdfront-matter) for more information.
    
    👌 Internal improvements
    
    👌 IMPROVE: Convert nested headings to rubrics.
    Headings within directives are not directly supported by sphinx, since they break the structure of the document. Previously myst-parser would emit a `myst.nested_header` warning, but still generate the heading, leading to unexpected outcomes.
    Now the warning is still emitted, but also the heading is rendered as a [rubric](https://docutils.sourceforge.io/docs/ref/rst/directives.html#rubric) non-structural heading (i.e. it will not show in the ToC).
    
    Other internal improvements primarily focussed in improving support for the for &quot;docutils-only&quot; use, introduced in `v0.16`:
    
    - ♻️ REFACTOR: `default_parser` -&gt; `create_md_parser` in [474](https://github.com/executablebooks/MyST-Parser/pull/474)
    - 👌 IMPROVE: Add `bullet` attribute to `bullet_list` node in [465](https://github.com/executablebooks/MyST-Parser/pull/465)
    - 👌 IMPROVE: Use correct renderer for `state.inline_text` in [466](https://github.com/executablebooks/MyST-Parser/pull/466)
    - 👌 IMPROVE: Docutils parser settings in [476](https://github.com/executablebooks/MyST-Parser/pull/476)
    - 🐛 FIX: front-matter rendering with docutils in [477](https://github.com/executablebooks/MyST-Parser/pull/477)
    - 👌 IMPROVE: Code block highlighting in [478](https://github.com/executablebooks/MyST-Parser/pull/478)
    - 👌 IMPROVE: `note_refname` for docutils internal links in [481](https://github.com/executablebooks/MyST-Parser/pull/481)
    - 🐛 FIX: Ordered list starting number in [483](https://github.com/executablebooks/MyST-Parser/pull/483)
    - 👌 IMPROVE: Propagate enumerated list suffix in [484](https://github.com/executablebooks/MyST-Parser/pull/484)
    - 👌 IMPROVE: `DocutilsRenderer.create_highlighted_code_block` in [488](https://github.com/executablebooks/MyST-Parser/pull/488)
    - 🐛 FIX: Source line reporting for nested parsing in [490](https://github.com/executablebooks/MyST-Parser/pull/490)
    - 🔧 MAINTAIN: Implement `MockInliner.parse` in [504](https://github.com/executablebooks/MyST-Parser/pull/504)
    

    0.16.1

    ✨ NEW: Add `myst_linkify_fuzzy_links` option.
    When using the [`linkify` extension](docs/syntax/optional.mdlinkify), this option can be used to disable matching of links that do not contain a schema (such as `http://`).
    

    0.16.0

    This release contains a number of exciting improvements:
    
    Upgrade of Markdown parser
    
    `markdown-it-py` has been upgraded to [v2.0.0](https://github.com/executablebooks/markdown-it-py/releases/tag/v2.0.0).
    This upgrade brings full compliance with the [CommonMark v0.30 specification](https://spec.commonmark.org/0.30/).
    
    Additionally, `mdit-py-plugins` has been upgraded to [v0.3.0](https://github.com/executablebooks/mdit-py-plugins/releases/tag/v0.3.0).
    This improves the parsing of the MyST target syntax, to allow for spaces and additional special characters in the target name,
    for example this is now valid:
    
    md
    (a bc   |&lt;&gt;*./_-+:)=
    
    Header
    
    
    Also MyST role syntax now supports unlimited length in the role name and new lines in the content.
    For example, this is now valid:
    
    md
    {abc}`xy
    new line`
    
    
    Improvements for Docutils-only use
    
    MyST now allows for Docutils-only use (outside of Sphinx), that allows for MyST configuration options to be set via the `docutils.conf` file, or on the command line.
    
    On installing MyST-Parser, the following CLI-commands are made available:
    
    - `myst-docutils-html`: converts MyST to HTML
    - `myst-docutils-html5`: converts MyST to HTML5
    - `myst-docutils-latex`: converts MyST to LaTeX
    - `myst-docutils-xml`: converts MyST to docutils-native XML
    - `myst-docutils-pseudoxml`: converts MyST to pseudo-XML (to visualise the AST structure)
    
    You can also install the [myst-docutils](https://pypi.org/project/myst-docutils/) package from `pip`,
    which includes no direct install requirements on docutils or sphinx.
    
    See [MyST with Docutils](docs/docutils.md) for more information.
    
    Thanks to help from [cpitclaudel](https://github.com/cpitclaudel)!
    
    Include MyST files in RST files
    
    With `docutils&gt;=0.17`, the `include` directive has a `parser` option.
    This can be used with myst-parser to include MyST files in RST files.
    
    md
    Parse using the docutils only parser:
    
    .. include:: include.md
    :parser: myst_parser.docutils_
    
    Parse using the sphinx parser:
    
    .. include:: include.md
    :parser: myst_parser.sphinx_
    
    
    Addition of the `fieldlist` syntax extension
    
    Field lists are mappings from field names to field bodies, based on the [reStructureText syntax](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists):
    
    rst
    :name only:
    :name: body
    :name:
    Multiple
    
    Paragraphs
    
    
    This should eventually allow for MyST Markdown docstrings! (see &lt;https://github.com/executablebooks/MyST-Parser/issues/228&gt;)
    
    See [Field Lists syntax](docs/syntax/optional.mdfield-lists) for more information.
    
    Improvements to table rendering
    
    Tables with no body are now allowed, for example:
    
    md
    | abc | def |
    | --- | --- |
    
    
    Also cell alignment HTML classes have now been changed to: `text-left`, `text-center`, or `text-right`, for example:
    
    md
    | left | center | right |
    | :--- | :----: | ----: |
    | a    | b      | c     |
    
    
    is converted to:
    
    html
    &lt;table class=&quot;colwidths-auto&quot;&gt;
    &lt;thead&gt;
    &lt;tr&gt;
     &lt;th class=&quot;text-left head&quot;&gt;&lt;p&gt;left&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-center head&quot;&gt;&lt;p&gt;center&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-right head&quot;&gt;&lt;p&gt;right&lt;/p&gt;&lt;/th&gt;
    &lt;/tr&gt;
    &lt;/thead&gt;
    &lt;tbody&gt;
    &lt;tr&gt;
     &lt;td class=&quot;text-left&quot;&gt;&lt;p&gt;a&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-center&quot;&gt;&lt;p&gt;b&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-right&quot;&gt;&lt;p&gt;c&lt;/p&gt;&lt;/td&gt;
    &lt;/tr&gt;
    &lt;/tbody&gt;
    &lt;/table&gt;
    
    
    These classes should be supported by most sphinx HTML themes.
    
    See [Tables syntax](docs/syntax/syntax.mdtables) for more information.
    
    Pull Requests
    
    - 🐛 FIX: Add mandatory attributes on `enumerated_list` by cpitclaudel in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - 📚 DOCS: Add reference to MySTyc in landing page by astrojuanlu in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    - ⬆️ UPGRADE: markdown-it-py v2, mdit-py-plugins v0.3 by chrisjsewell in [449](https://github.com/executablebooks/MyST-Parser/pull/449)
    - 👌 IMPROVE: Table rendering by chrisjsewell in [450](https://github.com/executablebooks/MyST-Parser/pull/450)
    - 🐛 FIX: Ensure parent files are re-built if `include` file changes by chrisjsewell in [451](https://github.com/executablebooks/MyST-Parser/pull/451)
    - 🐛 FIX: Convert empty directive option to `None` by chrisjsewell in [452](https://github.com/executablebooks/MyST-Parser/pull/452)
    - 👌 IMPROVE: Add `\\` for hard-breaks in latex by chrisjsewell in [453](https://github.com/executablebooks/MyST-Parser/pull/453)
    - 🔧 MAINTAIN: Remove empty &quot;sphinx&quot; extra by hukkin in [350](https://github.com/executablebooks/MyST-Parser/pull/350)
    - ✨ NEW: Add `fieldlist` extension by chrisjsewell in [455](https://github.com/executablebooks/MyST-Parser/pull/455)
    - ✨ NEW: Add Docutils MyST config and CLI by cpitclaudel in [426](https://github.com/executablebooks/MyST-Parser/pull/426)
    - 🔧 MAINTAIN: Add publishing job for `myst-docutils` by chrisjsewell in [456](https://github.com/executablebooks/MyST-Parser/pull/456)
    - 🧪 TESTS: Add for `gettext_additional_targets` by jpmckinney in [459](https://github.com/executablebooks/MyST-Parser/pull/459)
    
    New Contributors
    
    - cpitclaudel made their first contribution in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - astrojuanlu made their first contribution in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    
    **Full Changelog**: &lt;https://github.com/executablebooks/MyST-Parser/compare/v0.15.2...v0.16.0&gt;
    

    0.15.2

    This is mainly a maintenance release that fixes some incompatibilities with `sphinx&lt;3.1`, improvements for compatibility
    with `docutils=0.17`, and improvements to robustness.
    

    0.15.1

    👌 IMPROVE: MathJax compatibility with `nbsphinx`
    
    `nbsphinx` also overrides the MathJax configuration.
    For compatibility, `output_area` is added to the list of default processed classes, and the override warning is allowed to be suppressed with `suppress_warnings = [&quot;myst.mathjax&quot;]`.
    

    0.15.0

    Upgraded to `sphinx` v4 ⬆️
    
    A principe change in this release is to updates the requirements of myst-parser from `sphinx&gt;=2,&lt;4` to `sphinx&gt;=3,&lt;5`.
    
    Changed MathJax handling ♻️
    
    Instead of removing all `$` processing for the whole project,
    during MyST document parsing, the top-level section is now given the classes `tex2jax_ignore` and `mathjax_ignore` (turning off default MathJax processing of all HTML elements)
    and MathJax is then configured to process elements with the `tex2jax_process|mathjax_process|math` classes.
    
    See [the math syntax guide](docs/syntax/optional.mdmath-shortcuts) for further information.
    
    Set URL scheme defaults ‼️
    
    The `myst_url_schemes` default is now: `(&quot;http&quot;, &quot;https&quot;, &quot;mailto&quot;, &quot;ftp&quot;)`.
    This means that only these URL will be considered as external (e.g. `[](https://example.com)`),
    and references like `[](prefix:main)` will be considered as internal references.
    Set `myst_url_schemes = None`, to revert to the previous default.
    
    Added `myst_heading_slug_func` option 👌
    
    Use this option to specify a custom function to auto-generate heading anchors (see [Auto-generated header anchors](docs/syntax/optional.mdauto-generated-header-anchors)).
    
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    

    0.13.7

    👌 IMPROVE: Add warning for nested headers:
    
    Nested headers are not supported within most elements (this is a limitation of the docutils/sphinx document structure), and can lead to unexpected outcomes.
    For example in admonitions:
    
    `markdown
    {note}
    Unsupported Header
    
    `
    
    A warning (of type `myst.nested_header`) is now emitted when this occurs.
    
    🔧 MAINTAIN: Python 3.9 is now officially supported.
    

    0.13.6

    🐛 FIX: docutils `v0.17` compatibility
    

    0.13.5

    - ⬆️ UPGRADE: required markdown-it-py to `v0.6.2`:
    In particular, this fixes missing source line mappings for table rows and their children
    - 👌 IMPROVE: Store `rawtext` in AST nodes:
    We now ensure that the raw text is propagated from the Markdown tokens to the Sphinx AST.
    In particular, this is required by the `gettext` builder, to generate translation POT templates.
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    - ✨ NEW: Add warning types `myst.subtype`:
    All parsing warnings are assigned a type/subtype, and also the messages are appended with them.
    These warning types can be suppressed with the sphinx `suppress_warnings` config option.
    See [How-to suppress warnings](howto/warnings) for more information.
    

    0.13.3

    Minor fixes:
    
    - 🐛 FIX: front-matter parsing for bibliographic keys
    - 🐛 FIX: directive/role name translations
    - 👌 IMPROVE: Add warning for multiple footnote definitions
    

    0.13.2

    ✨ NEW: Add `html_admonition` extension
    
    : By adding `&quot;html_admonition&quot;` to `myst_enable_extensions`, you can enable parsing of `&lt;div class=&quot;admonition&quot;&gt;` HTML blocks to sphinx admonitions.
    : This is helpful when you care about viewing the &quot;source&quot; Markdown, such as in Jupyter Notebooks.
    : For example:
    html
    &lt;div class=&quot;admonition note&quot; name=&quot;html-admonition&quot;&gt;
    &lt;p class=&quot;title&quot;&gt;This is the **title**&lt;/p&gt;
    This is the *content*
    &lt;/div&gt;
    
    : See [the optional syntax guide](docs/syntax/optional.md) for further information.
    
    👌 IMPROVE: Footnotes
    
    : If the label is an integer, then it will always use this integer for the rendered label (i.e. they are manually numbered).
    : Add `myst_footnote_transition` configuration, to turn on/off transition line.
    : Add `footnotes` class to transition `&lt;hr&gt;` in HTML.
    : See [the syntax guide](docs/syntax/syntax.md) for further information.
    
    👌 IMPROVE: `substitution` extension logic
    
    : Parse inline substitutions without block rules, unless the substitution starts with a directive.
    
    🐛 FIX: Render front-matter as `field_list`
    
    : To improve use by sphinx extensions).
    
    👌 IMPROVE: Code quality
    
    : Add isort and mypy type checking to code base.
    
    (thanks to contributors akhmerov, tfiers)
    

    0.13.1

    👌 Directives can now be used for inline substitutions, e.g.
    
    md
    ---
    substitutions:
    key: |
     {image} img/fun-fish.png
     :alt: fishy
     :height: 20px
     
    ---
    
    An inline image: {{ key }}
    

    0.13.0

    This release makes some major updates to the optional syntaxes.
    For full details see [Optional MyST Syntaxes](docs/syntax/optional.md).
    
    🗑 Deprecations
    
    `myst_enable_extensions = [&quot;dollarmath&quot;, ...]` now replaces and deprecates individual enable configuration variables: `admonition_enable` -&gt; `&quot;colon_fence&quot;`, `figure_enable` -&gt; `&quot;colon_fence&quot;`, `dmath_enable` -&gt; `&quot;dollarmath&quot;`, `amsmath` -&gt; `&quot;colon_fence&quot;`, `deflist_enable` -&gt; `&quot;deflist&quot;`, `html_img_enable` -&gt; `&quot;html_image&quot;`.
    
    The `colon_fence` extension (replacing `admonition_enable`) now works exactly the same as normal `  ` code fences, but using `:::` delimiters. This is helpful for directives that contain Markdown text, for example:
    
    md
    :::{admonition} The title
    :class: note
    
    This note contains *Markdown*
    :::
    
    
    ✨ New
    
    The `smartquotes` extension will automatically convert standard quotations to their opening/closing variants:
    
    - `&#x27;single quotes&#x27;`: ‘single quotes’
    - `&quot;double quotes&quot;`:  “double quotes”
    
    The `linkify` extension will automatically identify “bare” web URLs, like `www.example.com`,  and add hyperlinks; www.example.com.
    This extension requires that [linkify-it-py](https://github.com/tsutsu3/linkify-it-py) is installed.
    
    The `replacements` extension will automatically convert some common typographic texts, such as `+-` -&gt; `±`.
    
    The `substitution` extension allows you to specify &quot;substitution definitions&quot; in either the `conf.py` (as `myst_substitutions`) and/or individual file&#x27;s front-matter (front-matter takes precedence), which will then replace substitution references. For example:
    
    md
    ---
    substitutions:
    key1: definition
    ---
    {{ key1 }}
    
    
    The substitutions are assessed as [jinja2 expressions](http://jinja.palletsprojects.com/) and includes the [Sphinx Environment](https://www.sphinx-doc.org/en/master/extdev/envapi.html) as `env`, so you can do powerful thinks like:
    
    
    {{ [key1, env.docname] | join(&#x27;/&#x27;) }}
    
    
    The `figure-md` directive has been added (replacing `enable_figure`), which parses a &quot;Markdown friendly&quot; figure (used with the `colon_fence` extension):
    
    md
    :::{figure-md} fig-target
    :class: myclass
    
    &lt;img src=&quot;img/fun-fish.png&quot; alt=&quot;fishy&quot; class=&quot;bg-primary mb-1&quot; width=&quot;200px&quot;&gt;
    
    This is a caption in **Markdown**
    :::
    
    
    👌 Improvements
    
    Using the `html_image` extension, HTML images are now processed for both blocks and (now) inline.
    
    So you can correctly do, for example:
    
    md
    I’m an inline image: &lt;img src=&quot;img/fun-fish.png&quot; height=&quot;20px&quot;&gt;
    
    | table column                              |
    | ----------------------------------------- |
    | &lt;img src=&quot;img/fun-fish.png&quot; width=&quot;20px&quot;&gt; |
    

    0.12.10

    🐛 FIX: allow dates to be parsed in frontmatter.
    : This fixes a bug that would raise errors at parse time if non-string date objects were in front-matter YAML. See [253](https://github.com/executablebooks/MyST-Parser/pull/253)
    

    0.12.9

    ✨ NEW: Auto-generate heading anchors.
    : This utilises `markdown-it-py`&#x27;s `anchors-plugin`, to generate unique anchor &quot;slugs&quot; for each header (up to a certain level),
    and allows them to be referenced *via* a relative path, e.g. `[](./file.mdheader-anchor)`, or in the same document, e.g. `[](header-anchor)`.
    
    Slugs are generated in the GitHub style ([see here](https://github.com/Flet/github-slugger)); lower-case text, removing punctuation, replacing spaces with `-`, enforce uniqueness *via* suffix enumeration `-1`.
    
    It is enabled in your `conf.py` *via* `myst_heading_anchors = 2` (sets maximum heading level).
    
    See [the documentation here](docs/syntax/optional.mdauto-generated-header-anchors).
    
    🐛 FIX: doc reference resolution for singlehtml/latex.
    : These reference resolutions are passed to the &quot;missing-reference&quot; event, and require the `node[&quot;refdoc&quot;]` attribute to be available, which was missing for `[text](./path/to/file.md)` type references.
    

    0.12.7

    ✨ NEW: Want to include your README.md in the documentation?
    : See [including a file from outside the docs folder](howto/include-readme).
    

    0.12.5

    ✨ NEW: Add Markdown figure syntax
    : Setting `myst_figure_enable = True` in your sphinx `conf.py`, combines the above two extended syntaxes,
    to create a fully Markdown compliant version of the `figure` directive.
    See [Markdown Figures](docs/syntax/optional.mdmarkdown-figures) for details.
    

    0.12.4

    👌 IMPROVE: the mathjax extension is now only overridden if strictly necessary (to support dollar and ams math), and the override is more precise, to mitigate any unwanted side-effects
    

    0.12.3

    ✨ NEW: Add definition lists.
    : This addition, enabled by `myst_deflist_enable = True`, allows for &quot;Pandoc style&quot; definition lists to be parsed and rendered, e.g.
    
    md
    Term 1
    : Definition
    
    
    See the [Definition Lists documentation](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists) for further details.
    
    👌 IMPROVE: mathjax_config override.
    : Only `mathjax_config[&quot;tex2jax&quot;]` will now be overridden, in order to not interfere with other user configurations, such as adding TeX macros.
    The configuration name has also changed from `myst_override_mathjax` to `myst_update_mathjax`.
    See [Mathjax and math parsing](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#mathjax-and-math-parsing) for further details.
    

    0.12.2

    ✨ NEW: Add the `eval-rst` directive
    
    : This directive parses its contents as ReStructuredText, which integrates back into the rest of the document, e.g. for cross-referencing. See [this documentation](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#how-directives-parse-content) for further explanation.
    
    In particular, this addition solves some outstanding user requests:
    
    - How-to [include rST files into a Markdown file](https://myst-parser.readthedocs.io/en/latest/using/howto.html#include-rst-files-into-a-markdown-file)
    - How-to [Use sphinx.ext.autodoc in Markdown files](https://myst-parser.readthedocs.io/en/latest/using/howto.html#use-sphinx-ext-autodoc-in-markdown-files)
    
    Thanks to [stephenroller](https://github.com/stephenroller) for the contribution 🎉
    

    0.12.1

    ✨ NEW: Add `myst_commonmark_only` config option, for restricting the parser to strict CommonMark (no extensions).
    

    0.12.0

    ‼️ BREAKING
    
    If you are using math in your documents, be sure to read the updated [Math syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#math-shortcuts)!
    In particular, the Mathjax configuration is now overridden, such that LaTeX environments will only be rendered if `myst_amsmath_enable=True` is set.
    
    The `myst_math_delimiters` option has also been removed (please open an issue if you would like brackets math parsing to be re-implemented).
    
    In addition the `myst_html_img` option name has been changed to `myst_html_img_enable`.
    
    Some underlying code has also been refactored, to centralise handling of configuration options (see [commit 98573b9](https://github.com/executablebooks/MyST-Parser/commit/98573b9c6e3602ab31d627b5266ae5c1ba2c9e5f)).
    
    Improved 👌
    
    More configuration options for math parsing (see [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)).
    

    0.11.2

    Added ✨
    
    - `&lt;img src=&quot;file.png&quot; width=&quot;200px&quot;&gt;` tag parsing to sphinx representation, see [the image syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#images)
    
    Improved 👌
    
    - `[title](link)` syntax now works with intersphinx references.
    Recognised URI schemas can also be configured, see the [configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)
    

    0.11.1

    Fix
    
    - Correctly pin required minimum markdown-it-py version
    

    0.11.0

    Added ✨
    
    * Special admonition directive syntax (optional):
    
    md
    :::{note}
    This text is **standard** _Markdown_
    :::
    
    
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#admonition-directives-special-syntax-optional) for details.
    
    * Direct parsing of [amsmath](https://ctan.org/pkg/amsmath) LaTeX equations (optional).
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#direct-latex-math-optional) for details.
    
    Breaking ‼️
    
    * Sphinx configuration options are now set as separate variables, rather than a single dict.
    See [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options) for details.
    

    0.10.0

    ([full changelog](https://github.com/executablebooks/MyST-Parser/compare/v0.9.1...aaed58808af485c29bbbf73c5aac10697bfa08b9))
    
    Improved 👌
    
    * Support Sphinx version 3 [197](https://github.com/executablebooks/MyST-Parser/pull/197) ([chrisjsewell](https://github.com/chrisjsewell))
    * Update Trove Classifiers [192](https://github.com/executablebooks/MyST-Parser/pull/192) ([chrisjsewell](https://github.com/chrisjsewell))
    * Add functionality to use docutils specialized role [189](https://github.com/executablebooks/MyST-Parser/pull/189) ([chrisjsewell](https://github.com/chrisjsewell))
    
    Contributors to this release
    
    ([GitHub contributors page for this release](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-07-20&amp;to=2020-08-07&amp;type=c))
    
    [AakashGfude](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3AAakashGfude+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [welcome](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awelcome+updated%3A2020-07-20..2020-08-07&amp;type=Issues)
    
    Past Releases
    
    Contributors
    
    ([GitHub contributors page for these releases](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-01-01&amp;to=2020-07-20&amp;type=c))
    
    [akhmerov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aakhmerov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [certik](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acertik+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [dhermes](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Adhermes+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [filippo82](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Afilippo82+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jlperla](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajlperla+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jstac](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajstac+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [martinagvilas](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amartinagvilas+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mlncn](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amlncn+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mmcky](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ammcky+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [moorepants](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amoorepants+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [najuzilu](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anajuzilu+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [nathancarter](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anathancarter+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [pauleveritt](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Apauleveritt+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [phaustin](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aphaustin+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rossbar](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arossbar+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rowanc1](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arowanc1+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [sbliven](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Asbliven+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-01-01..2020-07-20&amp;type=Issues)
    
    Links
    • PyPI: https://pypi.org/project/myst-parser
    • Changelog: https://pyup.io/changelogs/myst-parser/
    • Repo: https://github.com/executablebooks/MyST-Parser

    Update pytest from 7.0.0 to 7.0.1.

    Changelog

    7.0.1

    =========================
    
    Bug Fixes
    ---------
    
    - `9608 &lt;https://github.com/pytest-dev/pytest/issues/9608&gt;`_: Fix invalid importing of ``importlib.readers`` in Python 3.9.
    
    
    - `9610 &lt;https://github.com/pytest-dev/pytest/issues/9610&gt;`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method.
    Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`.
    Regressed in pytest 7.0.0.
    
    
    - `9636 &lt;https://github.com/pytest-dev/pytest/issues/9636&gt;`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin.
    
    
    - `9642 &lt;https://github.com/pytest-dev/pytest/issues/9642&gt;`_: Fix running tests by id with ``::`` in the parametrize portion.
    
    
    - `9643 &lt;https://github.com/pytest-dev/pytest/issues/9643&gt;`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and
    :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters &lt;warnings&gt;`.
    
    Links
    • PyPI: https://pypi.org/project/pytest
    • Changelog: https://pyup.io/changelogs/pytest/
    • Homepage: https://docs.pytest.org/en/latest/
    update 
    opened by pyup-bot 1
  • Bug #12345 Scheduled daily dependency update on Friday

    Bug #12345 Scheduled daily dependency update on Friday

    Update secretum_sphinx_theme from 2022.1 to 2022.1.

    The bot wasn't able to find a changelog for this release. Got an idea?

    Links
    • PyPI: https://pypi.org/project/secretum-sphinx-theme
    • Repo: https://github.com/secretum-inc/secretum_sphinx_theme/archive/v2022.1.tar.gz

    Update myst_parser from 0.17.0 to 0.17.0.

    Changelog

    0.17.0

    This release contains a number of breaking improvements.
    
    Full Changelog: [v0.16.1...v0.17.0](https://github.com/executablebooks/MyST-Parser/compare/v0.16.1...v0.17.0)
    
    ‼️ Markdown link resolution improvements
    
    Markdown links are of the format `[text](link)`.
    MyST-Parser looks to smartly resolve such links, by identifying if they are:
    
    1. A link to an external resource, e.g. `[text](http://example.com)`
    2. A link to another source document, e.g. `[text](file.md)`
    - If `header-anchors` are enabled, anchor links are also supported, e.g. `[text](file.mdanchor)`
    3. A link to an internal sphinx cross-reference, e.g. `[text](my-reference)`
    
    an additional situation is now supported:
    
    4. A link to a source file, which is not a document, e.g. `[text](file.js)`. This behaves similarly to the sphinx `download` role.
    
    In addition, configuration to more finely tune this behaviour has been added.
    
    - `myst_all_links_external=True`, will make all links be treated as (1)
    - `myst_url_schemes=(&quot;http&quot;, &quot;https&quot;)`, sets what URL schemes are treated as (1)
    - `myst_ref_domains=(&quot;std&quot;, &quot;py&quot;)`, sets what Sphinx reference domains are checked, when handling (3)
    
    See [Markdown Links and Referencing](docs/syntax/syntax.mdmarkdown-links-and-referencing) for more information.
    
    ‼️ Dollarmath is now disabled by default
    
    The default configuration is now `myst_enable_extensions=()`, instead of `myst_enable_extensions=(&quot;dollarmath&quot;,)`.
    If you are using math enclosed in `$` or `$$` in your documents, you should enable `dollarmath` explicitly.
    
    See [Dollar delimited math](docs/syntax/optional.mdmath-shortcuts) for more information.
    
    ⬆️ Drop Python 3.6 support
    
    MyST-Parser now supports, and is tested against, Python 3.7 to 3.10.
    
    ✨ Add the `strikethrough` extension and `myst_gfm_only` configuration
    
    The `strikethrough` extension allows text within `~~` delimiters to have a strike-through (horizontal line) placed over it.
    For example, `~~strikethrough with *emphasis*~~` renders as: ~~strikethrough with *emphasis*~~.
    
    **Important**: This extension is currently only supported for HTML output.
    
    See [Strikethrough](docs/syntax/optional.mdstrikethrough) for more information.
    
    The `myst_gfm_only=True` configuration sets up specific configuration, to enable compliance only with [GitHub-flavored Markdown](https://github.github.com/gfm/), including enabling the `strikethrough`, `tasklist` and `linkify` extensions, but disabling support for roles and directives.
    
    ✨ Add `myst_title_to_header` configuration
    
    Setting `myst_title_to_header=True`, allows for a `title` key in the frontmatter to be used as the document title.
    for example:
    
    md
    ---
    title: My Title with *emphasis*
    ---
    
    
    would be equivalent to:
    
    md
    My Title with *emphasis*
    
    
    See [Front matter](docs/syntax/syntax.mdfront-matter) for more information.
    
    👌 Internal improvements
    
    👌 IMPROVE: Convert nested headings to rubrics.
    Headings within directives are not directly supported by sphinx, since they break the structure of the document. Previously myst-parser would emit a `myst.nested_header` warning, but still generate the heading, leading to unexpected outcomes.
    Now the warning is still emitted, but also the heading is rendered as a [rubric](https://docutils.sourceforge.io/docs/ref/rst/directives.html#rubric) non-structural heading (i.e. it will not show in the ToC).
    
    Other internal improvements primarily focussed in improving support for the for &quot;docutils-only&quot; use, introduced in `v0.16`:
    
    - ♻️ REFACTOR: `default_parser` -&gt; `create_md_parser` in [474](https://github.com/executablebooks/MyST-Parser/pull/474)
    - 👌 IMPROVE: Add `bullet` attribute to `bullet_list` node in [465](https://github.com/executablebooks/MyST-Parser/pull/465)
    - 👌 IMPROVE: Use correct renderer for `state.inline_text` in [466](https://github.com/executablebooks/MyST-Parser/pull/466)
    - 👌 IMPROVE: Docutils parser settings in [476](https://github.com/executablebooks/MyST-Parser/pull/476)
    - 🐛 FIX: front-matter rendering with docutils in [477](https://github.com/executablebooks/MyST-Parser/pull/477)
    - 👌 IMPROVE: Code block highlighting in [478](https://github.com/executablebooks/MyST-Parser/pull/478)
    - 👌 IMPROVE: `note_refname` for docutils internal links in [481](https://github.com/executablebooks/MyST-Parser/pull/481)
    - 🐛 FIX: Ordered list starting number in [483](https://github.com/executablebooks/MyST-Parser/pull/483)
    - 👌 IMPROVE: Propagate enumerated list suffix in [484](https://github.com/executablebooks/MyST-Parser/pull/484)
    - 👌 IMPROVE: `DocutilsRenderer.create_highlighted_code_block` in [488](https://github.com/executablebooks/MyST-Parser/pull/488)
    - 🐛 FIX: Source line reporting for nested parsing in [490](https://github.com/executablebooks/MyST-Parser/pull/490)
    - 🔧 MAINTAIN: Implement `MockInliner.parse` in [504](https://github.com/executablebooks/MyST-Parser/pull/504)
    

    0.16.1

    ✨ NEW: Add `myst_linkify_fuzzy_links` option.
    When using the [`linkify` extension](docs/syntax/optional.mdlinkify), this option can be used to disable matching of links that do not contain a schema (such as `http://`).
    

    0.16.0

    This release contains a number of exciting improvements:
    
    Upgrade of Markdown parser
    
    `markdown-it-py` has been upgraded to [v2.0.0](https://github.com/executablebooks/markdown-it-py/releases/tag/v2.0.0).
    This upgrade brings full compliance with the [CommonMark v0.30 specification](https://spec.commonmark.org/0.30/).
    
    Additionally, `mdit-py-plugins` has been upgraded to [v0.3.0](https://github.com/executablebooks/mdit-py-plugins/releases/tag/v0.3.0).
    This improves the parsing of the MyST target syntax, to allow for spaces and additional special characters in the target name,
    for example this is now valid:
    
    md
    (a bc   |&lt;&gt;*./_-+:)=
    
    Header
    
    
    Also MyST role syntax now supports unlimited length in the role name and new lines in the content.
    For example, this is now valid:
    
    md
    {abc}`xy
    new line`
    
    
    Improvements for Docutils-only use
    
    MyST now allows for Docutils-only use (outside of Sphinx), that allows for MyST configuration options to be set via the `docutils.conf` file, or on the command line.
    
    On installing MyST-Parser, the following CLI-commands are made available:
    
    - `myst-docutils-html`: converts MyST to HTML
    - `myst-docutils-html5`: converts MyST to HTML5
    - `myst-docutils-latex`: converts MyST to LaTeX
    - `myst-docutils-xml`: converts MyST to docutils-native XML
    - `myst-docutils-pseudoxml`: converts MyST to pseudo-XML (to visualise the AST structure)
    
    You can also install the [myst-docutils](https://pypi.org/project/myst-docutils/) package from `pip`,
    which includes no direct install requirements on docutils or sphinx.
    
    See [MyST with Docutils](docs/docutils.md) for more information.
    
    Thanks to help from [cpitclaudel](https://github.com/cpitclaudel)!
    
    Include MyST files in RST files
    
    With `docutils&gt;=0.17`, the `include` directive has a `parser` option.
    This can be used with myst-parser to include MyST files in RST files.
    
    md
    Parse using the docutils only parser:
    
    .. include:: include.md
    :parser: myst_parser.docutils_
    
    Parse using the sphinx parser:
    
    .. include:: include.md
    :parser: myst_parser.sphinx_
    
    
    Addition of the `fieldlist` syntax extension
    
    Field lists are mappings from field names to field bodies, based on the [reStructureText syntax](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists):
    
    rst
    :name only:
    :name: body
    :name:
    Multiple
    
    Paragraphs
    
    
    This should eventually allow for MyST Markdown docstrings! (see &lt;https://github.com/executablebooks/MyST-Parser/issues/228&gt;)
    
    See [Field Lists syntax](docs/syntax/optional.mdfield-lists) for more information.
    
    Improvements to table rendering
    
    Tables with no body are now allowed, for example:
    
    md
    | abc | def |
    | --- | --- |
    
    
    Also cell alignment HTML classes have now been changed to: `text-left`, `text-center`, or `text-right`, for example:
    
    md
    | left | center | right |
    | :--- | :----: | ----: |
    | a    | b      | c     |
    
    
    is converted to:
    
    html
    &lt;table class=&quot;colwidths-auto&quot;&gt;
    &lt;thead&gt;
    &lt;tr&gt;
     &lt;th class=&quot;text-left head&quot;&gt;&lt;p&gt;left&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-center head&quot;&gt;&lt;p&gt;center&lt;/p&gt;&lt;/th&gt;
     &lt;th class=&quot;text-right head&quot;&gt;&lt;p&gt;right&lt;/p&gt;&lt;/th&gt;
    &lt;/tr&gt;
    &lt;/thead&gt;
    &lt;tbody&gt;
    &lt;tr&gt;
     &lt;td class=&quot;text-left&quot;&gt;&lt;p&gt;a&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-center&quot;&gt;&lt;p&gt;b&lt;/p&gt;&lt;/td&gt;
     &lt;td class=&quot;text-right&quot;&gt;&lt;p&gt;c&lt;/p&gt;&lt;/td&gt;
    &lt;/tr&gt;
    &lt;/tbody&gt;
    &lt;/table&gt;
    
    
    These classes should be supported by most sphinx HTML themes.
    
    See [Tables syntax](docs/syntax/syntax.mdtables) for more information.
    
    Pull Requests
    
    - 🐛 FIX: Add mandatory attributes on `enumerated_list` by cpitclaudel in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - 📚 DOCS: Add reference to MySTyc in landing page by astrojuanlu in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    - ⬆️ UPGRADE: markdown-it-py v2, mdit-py-plugins v0.3 by chrisjsewell in [449](https://github.com/executablebooks/MyST-Parser/pull/449)
    - 👌 IMPROVE: Table rendering by chrisjsewell in [450](https://github.com/executablebooks/MyST-Parser/pull/450)
    - 🐛 FIX: Ensure parent files are re-built if `include` file changes by chrisjsewell in [451](https://github.com/executablebooks/MyST-Parser/pull/451)
    - 🐛 FIX: Convert empty directive option to `None` by chrisjsewell in [452](https://github.com/executablebooks/MyST-Parser/pull/452)
    - 👌 IMPROVE: Add `\\` for hard-breaks in latex by chrisjsewell in [453](https://github.com/executablebooks/MyST-Parser/pull/453)
    - 🔧 MAINTAIN: Remove empty &quot;sphinx&quot; extra by hukkin in [350](https://github.com/executablebooks/MyST-Parser/pull/350)
    - ✨ NEW: Add `fieldlist` extension by chrisjsewell in [455](https://github.com/executablebooks/MyST-Parser/pull/455)
    - ✨ NEW: Add Docutils MyST config and CLI by cpitclaudel in [426](https://github.com/executablebooks/MyST-Parser/pull/426)
    - 🔧 MAINTAIN: Add publishing job for `myst-docutils` by chrisjsewell in [456](https://github.com/executablebooks/MyST-Parser/pull/456)
    - 🧪 TESTS: Add for `gettext_additional_targets` by jpmckinney in [459](https://github.com/executablebooks/MyST-Parser/pull/459)
    
    New Contributors
    
    - cpitclaudel made their first contribution in [418](https://github.com/executablebooks/MyST-Parser/pull/418)
    - astrojuanlu made their first contribution in [413](https://github.com/executablebooks/MyST-Parser/pull/413)
    
    **Full Changelog**: &lt;https://github.com/executablebooks/MyST-Parser/compare/v0.15.2...v0.16.0&gt;
    

    0.15.2

    This is mainly a maintenance release that fixes some incompatibilities with `sphinx&lt;3.1`, improvements for compatibility
    with `docutils=0.17`, and improvements to robustness.
    

    0.15.1

    👌 IMPROVE: MathJax compatibility with `nbsphinx`
    
    `nbsphinx` also overrides the MathJax configuration.
    For compatibility, `output_area` is added to the list of default processed classes, and the override warning is allowed to be suppressed with `suppress_warnings = [&quot;myst.mathjax&quot;]`.
    

    0.15.0

    Upgraded to `sphinx` v4 ⬆️
    
    A principe change in this release is to updates the requirements of myst-parser from `sphinx&gt;=2,&lt;4` to `sphinx&gt;=3,&lt;5`.
    
    Changed MathJax handling ♻️
    
    Instead of removing all `$` processing for the whole project,
    during MyST document parsing, the top-level section is now given the classes `tex2jax_ignore` and `mathjax_ignore` (turning off default MathJax processing of all HTML elements)
    and MathJax is then configured to process elements with the `tex2jax_process|mathjax_process|math` classes.
    
    See [the math syntax guide](docs/syntax/optional.mdmath-shortcuts) for further information.
    
    Set URL scheme defaults ‼️
    
    The `myst_url_schemes` default is now: `(&quot;http&quot;, &quot;https&quot;, &quot;mailto&quot;, &quot;ftp&quot;)`.
    This means that only these URL will be considered as external (e.g. `[](https://example.com)`),
    and references like `[](prefix:main)` will be considered as internal references.
    Set `myst_url_schemes = None`, to revert to the previous default.
    
    Added `myst_heading_slug_func` option 👌
    
    Use this option to specify a custom function to auto-generate heading anchors (see [Auto-generated header anchors](docs/syntax/optional.mdauto-generated-header-anchors)).
    
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    

    0.13.7

    👌 IMPROVE: Add warning for nested headers:
    
    Nested headers are not supported within most elements (this is a limitation of the docutils/sphinx document structure), and can lead to unexpected outcomes.
    For example in admonitions:
    
    `markdown
    {note}
    Unsupported Header
    
    `
    
    A warning (of type `myst.nested_header`) is now emitted when this occurs.
    
    🔧 MAINTAIN: Python 3.9 is now officially supported.
    

    0.13.6

    🐛 FIX: docutils `v0.17` compatibility
    

    0.13.5

    - ⬆️ UPGRADE: required markdown-it-py to `v0.6.2`:
    In particular, this fixes missing source line mappings for table rows and their children
    - 👌 IMPROVE: Store `rawtext` in AST nodes:
    We now ensure that the raw text is propagated from the Markdown tokens to the Sphinx AST.
    In particular, this is required by the `gettext` builder, to generate translation POT templates.
    Thanks to [jpmckinney](https://github.com/jpmckinney)!
    - ✨ NEW: Add warning types `myst.subtype`:
    All parsing warnings are assigned a type/subtype, and also the messages are appended with them.
    These warning types can be suppressed with the sphinx `suppress_warnings` config option.
    See [How-to suppress warnings](howto/warnings) for more information.
    

    0.13.3

    Minor fixes:
    
    - 🐛 FIX: front-matter parsing for bibliographic keys
    - 🐛 FIX: directive/role name translations
    - 👌 IMPROVE: Add warning for multiple footnote definitions
    

    0.13.2

    ✨ NEW: Add `html_admonition` extension
    
    : By adding `&quot;html_admonition&quot;` to `myst_enable_extensions`, you can enable parsing of `&lt;div class=&quot;admonition&quot;&gt;` HTML blocks to sphinx admonitions.
    : This is helpful when you care about viewing the &quot;source&quot; Markdown, such as in Jupyter Notebooks.
    : For example:
    html
    &lt;div class=&quot;admonition note&quot; name=&quot;html-admonition&quot;&gt;
    &lt;p class=&quot;title&quot;&gt;This is the **title**&lt;/p&gt;
    This is the *content*
    &lt;/div&gt;
    
    : See [the optional syntax guide](docs/syntax/optional.md) for further information.
    
    👌 IMPROVE: Footnotes
    
    : If the label is an integer, then it will always use this integer for the rendered label (i.e. they are manually numbered).
    : Add `myst_footnote_transition` configuration, to turn on/off transition line.
    : Add `footnotes` class to transition `&lt;hr&gt;` in HTML.
    : See [the syntax guide](docs/syntax/syntax.md) for further information.
    
    👌 IMPROVE: `substitution` extension logic
    
    : Parse inline substitutions without block rules, unless the substitution starts with a directive.
    
    🐛 FIX: Render front-matter as `field_list`
    
    : To improve use by sphinx extensions).
    
    👌 IMPROVE: Code quality
    
    : Add isort and mypy type checking to code base.
    
    (thanks to contributors akhmerov, tfiers)
    

    0.13.1

    👌 Directives can now be used for inline substitutions, e.g.
    
    md
    ---
    substitutions:
    key: |
     {image} img/fun-fish.png
     :alt: fishy
     :height: 20px
     
    ---
    
    An inline image: {{ key }}
    

    0.13.0

    This release makes some major updates to the optional syntaxes.
    For full details see [Optional MyST Syntaxes](docs/syntax/optional.md).
    
    🗑 Deprecations
    
    `myst_enable_extensions = [&quot;dollarmath&quot;, ...]` now replaces and deprecates individual enable configuration variables: `admonition_enable` -&gt; `&quot;colon_fence&quot;`, `figure_enable` -&gt; `&quot;colon_fence&quot;`, `dmath_enable` -&gt; `&quot;dollarmath&quot;`, `amsmath` -&gt; `&quot;colon_fence&quot;`, `deflist_enable` -&gt; `&quot;deflist&quot;`, `html_img_enable` -&gt; `&quot;html_image&quot;`.
    
    The `colon_fence` extension (replacing `admonition_enable`) now works exactly the same as normal `  ` code fences, but using `:::` delimiters. This is helpful for directives that contain Markdown text, for example:
    
    md
    :::{admonition} The title
    :class: note
    
    This note contains *Markdown*
    :::
    
    
    ✨ New
    
    The `smartquotes` extension will automatically convert standard quotations to their opening/closing variants:
    
    - `&#x27;single quotes&#x27;`: ‘single quotes’
    - `&quot;double quotes&quot;`:  “double quotes”
    
    The `linkify` extension will automatically identify “bare” web URLs, like `www.example.com`,  and add hyperlinks; www.example.com.
    This extension requires that [linkify-it-py](https://github.com/tsutsu3/linkify-it-py) is installed.
    
    The `replacements` extension will automatically convert some common typographic texts, such as `+-` -&gt; `±`.
    
    The `substitution` extension allows you to specify &quot;substitution definitions&quot; in either the `conf.py` (as `myst_substitutions`) and/or individual file&#x27;s front-matter (front-matter takes precedence), which will then replace substitution references. For example:
    
    md
    ---
    substitutions:
    key1: definition
    ---
    {{ key1 }}
    
    
    The substitutions are assessed as [jinja2 expressions](http://jinja.palletsprojects.com/) and includes the [Sphinx Environment](https://www.sphinx-doc.org/en/master/extdev/envapi.html) as `env`, so you can do powerful thinks like:
    
    
    {{ [key1, env.docname] | join(&#x27;/&#x27;) }}
    
    
    The `figure-md` directive has been added (replacing `enable_figure`), which parses a &quot;Markdown friendly&quot; figure (used with the `colon_fence` extension):
    
    md
    :::{figure-md} fig-target
    :class: myclass
    
    &lt;img src=&quot;img/fun-fish.png&quot; alt=&quot;fishy&quot; class=&quot;bg-primary mb-1&quot; width=&quot;200px&quot;&gt;
    
    This is a caption in **Markdown**
    :::
    
    
    👌 Improvements
    
    Using the `html_image` extension, HTML images are now processed for both blocks and (now) inline.
    
    So you can correctly do, for example:
    
    md
    I’m an inline image: &lt;img src=&quot;img/fun-fish.png&quot; height=&quot;20px&quot;&gt;
    
    | table column                              |
    | ----------------------------------------- |
    | &lt;img src=&quot;img/fun-fish.png&quot; width=&quot;20px&quot;&gt; |
    

    0.12.10

    🐛 FIX: allow dates to be parsed in frontmatter.
    : This fixes a bug that would raise errors at parse time if non-string date objects were in front-matter YAML. See [253](https://github.com/executablebooks/MyST-Parser/pull/253)
    

    0.12.9

    ✨ NEW: Auto-generate heading anchors.
    : This utilises `markdown-it-py`&#x27;s `anchors-plugin`, to generate unique anchor &quot;slugs&quot; for each header (up to a certain level),
    and allows them to be referenced *via* a relative path, e.g. `[](./file.mdheader-anchor)`, or in the same document, e.g. `[](header-anchor)`.
    
    Slugs are generated in the GitHub style ([see here](https://github.com/Flet/github-slugger)); lower-case text, removing punctuation, replacing spaces with `-`, enforce uniqueness *via* suffix enumeration `-1`.
    
    It is enabled in your `conf.py` *via* `myst_heading_anchors = 2` (sets maximum heading level).
    
    See [the documentation here](docs/syntax/optional.mdauto-generated-header-anchors).
    
    🐛 FIX: doc reference resolution for singlehtml/latex.
    : These reference resolutions are passed to the &quot;missing-reference&quot; event, and require the `node[&quot;refdoc&quot;]` attribute to be available, which was missing for `[text](./path/to/file.md)` type references.
    

    0.12.7

    ✨ NEW: Want to include your README.md in the documentation?
    : See [including a file from outside the docs folder](howto/include-readme).
    

    0.12.5

    ✨ NEW: Add Markdown figure syntax
    : Setting `myst_figure_enable = True` in your sphinx `conf.py`, combines the above two extended syntaxes,
    to create a fully Markdown compliant version of the `figure` directive.
    See [Markdown Figures](docs/syntax/optional.mdmarkdown-figures) for details.
    

    0.12.4

    👌 IMPROVE: the mathjax extension is now only overridden if strictly necessary (to support dollar and ams math), and the override is more precise, to mitigate any unwanted side-effects
    

    0.12.3

    ✨ NEW: Add definition lists.
    : This addition, enabled by `myst_deflist_enable = True`, allows for &quot;Pandoc style&quot; definition lists to be parsed and rendered, e.g.
    
    md
    Term 1
    : Definition
    
    
    See the [Definition Lists documentation](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists) for further details.
    
    👌 IMPROVE: mathjax_config override.
    : Only `mathjax_config[&quot;tex2jax&quot;]` will now be overridden, in order to not interfere with other user configurations, such as adding TeX macros.
    The configuration name has also changed from `myst_override_mathjax` to `myst_update_mathjax`.
    See [Mathjax and math parsing](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#mathjax-and-math-parsing) for further details.
    

    0.12.2

    ✨ NEW: Add the `eval-rst` directive
    
    : This directive parses its contents as ReStructuredText, which integrates back into the rest of the document, e.g. for cross-referencing. See [this documentation](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#how-directives-parse-content) for further explanation.
    
    In particular, this addition solves some outstanding user requests:
    
    - How-to [include rST files into a Markdown file](https://myst-parser.readthedocs.io/en/latest/using/howto.html#include-rst-files-into-a-markdown-file)
    - How-to [Use sphinx.ext.autodoc in Markdown files](https://myst-parser.readthedocs.io/en/latest/using/howto.html#use-sphinx-ext-autodoc-in-markdown-files)
    
    Thanks to [stephenroller](https://github.com/stephenroller) for the contribution 🎉
    

    0.12.1

    ✨ NEW: Add `myst_commonmark_only` config option, for restricting the parser to strict CommonMark (no extensions).
    

    0.12.0

    ‼️ BREAKING
    
    If you are using math in your documents, be sure to read the updated [Math syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#math-shortcuts)!
    In particular, the Mathjax configuration is now overridden, such that LaTeX environments will only be rendered if `myst_amsmath_enable=True` is set.
    
    The `myst_math_delimiters` option has also been removed (please open an issue if you would like brackets math parsing to be re-implemented).
    
    In addition the `myst_html_img` option name has been changed to `myst_html_img_enable`.
    
    Some underlying code has also been refactored, to centralise handling of configuration options (see [commit 98573b9](https://github.com/executablebooks/MyST-Parser/commit/98573b9c6e3602ab31d627b5266ae5c1ba2c9e5f)).
    
    Improved 👌
    
    More configuration options for math parsing (see [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)).
    

    0.11.2

    Added ✨
    
    - `&lt;img src=&quot;file.png&quot; width=&quot;200px&quot;&gt;` tag parsing to sphinx representation, see [the image syntax guide](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#images)
    
    Improved 👌
    
    - `[title](link)` syntax now works with intersphinx references.
    Recognised URI schemas can also be configured, see the [configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options)
    

    0.11.1

    Fix
    
    - Correctly pin required minimum markdown-it-py version
    

    0.11.0

    Added ✨
    
    * Special admonition directive syntax (optional):
    
    md
    :::{note}
    This text is **standard** _Markdown_
    :::
    
    
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#admonition-directives-special-syntax-optional) for details.
    
    * Direct parsing of [amsmath](https://ctan.org/pkg/amsmath) LaTeX equations (optional).
    See [the syntax guide section](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#direct-latex-math-optional) for details.
    
    Breaking ‼️
    
    * Sphinx configuration options are now set as separate variables, rather than a single dict.
    See [MyST configuration options](https://myst-parser.readthedocs.io/en/latest/using/intro.html#myst-configuration-options) for details.
    

    0.10.0

    ([full changelog](https://github.com/executablebooks/MyST-Parser/compare/v0.9.1...aaed58808af485c29bbbf73c5aac10697bfa08b9))
    
    Improved 👌
    
    * Support Sphinx version 3 [197](https://github.com/executablebooks/MyST-Parser/pull/197) ([chrisjsewell](https://github.com/chrisjsewell))
    * Update Trove Classifiers [192](https://github.com/executablebooks/MyST-Parser/pull/192) ([chrisjsewell](https://github.com/chrisjsewell))
    * Add functionality to use docutils specialized role [189](https://github.com/executablebooks/MyST-Parser/pull/189) ([chrisjsewell](https://github.com/chrisjsewell))
    
    Contributors to this release
    
    ([GitHub contributors page for this release](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-07-20&amp;to=2020-08-07&amp;type=c))
    
    [AakashGfude](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3AAakashGfude+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-07-20..2020-08-07&amp;type=Issues) | [welcome](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awelcome+updated%3A2020-07-20..2020-08-07&amp;type=Issues)
    
    Past Releases
    
    Contributors
    
    ([GitHub contributors page for these releases](https://github.com/executablebooks/MyST-Parser/graphs/contributors?from=2020-01-01&amp;to=2020-07-20&amp;type=c))
    
    [akhmerov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aakhmerov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [asmeurer](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aasmeurer+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [certik](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acertik+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acholdgraf+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [chrisjsewell](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Achrisjsewell+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [codecov](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Acodecov+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [dhermes](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Adhermes+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [filippo82](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Afilippo82+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jlperla](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajlperla+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [jstac](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ajstac+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [martinagvilas](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amartinagvilas+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mlncn](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amlncn+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [mmcky](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Ammcky+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [moorepants](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Amoorepants+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [najuzilu](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anajuzilu+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [nathancarter](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Anathancarter+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [pauleveritt](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Apauleveritt+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [phaustin](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Aphaustin+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rossbar](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arossbar+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [rowanc1](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Arowanc1+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [sbliven](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Asbliven+updated%3A2020-01-01..2020-07-20&amp;type=Issues) | [webknjaz](https://github.com/search?q=repo%3Aexecutablebooks%2FMyST-Parser+involves%3Awebknjaz+updated%3A2020-01-01..2020-07-20&amp;type=Issues)
    
    Links
    • PyPI: https://pypi.org/project/myst-parser
    • Changelog: https://pyup.io/changelogs/myst-parser/
    • Repo: https://github.com/executablebooks/MyST-Parser

    Update pytest from 7.0.0 to 7.0.1.

    Changelog

    7.0.1

    =========================
    
    Bug Fixes
    ---------
    
    - `9608 &lt;https://github.com/pytest-dev/pytest/issues/9608&gt;`_: Fix invalid importing of ``importlib.readers`` in Python 3.9.
    
    
    - `9610 &lt;https://github.com/pytest-dev/pytest/issues/9610&gt;`_: Restore `UnitTestFunction.obj` to return unbound rather than bound method.
    Fixes a crash during a failed teardown in unittest TestCases with non-default `__init__`.
    Regressed in pytest 7.0.0.
    
    
    - `9636 &lt;https://github.com/pytest-dev/pytest/issues/9636&gt;`_: The ``pythonpath`` plugin was renamed to ``python_path``. This avoids a conflict with the ``pytest-pythonpath`` plugin.
    
    
    - `9642 &lt;https://github.com/pytest-dev/pytest/issues/9642&gt;`_: Fix running tests by id with ``::`` in the parametrize portion.
    
    
    - `9643 &lt;https://github.com/pytest-dev/pytest/issues/9643&gt;`_: Delay issuing a :class:`~pytest.PytestWarning` about diamond inheritance involving :class:`~pytest.Item` and
    :class:`~pytest.Collector` so it can be filtered using :ref:`standard warning filters &lt;warnings&gt;`.
    
    Links
    • PyPI: https://pypi.org/project/pytest
    • Changelog: https://pyup.io/changelogs/pytest/
    • Homepage: https://docs.pytest.org/en/latest/
    update 
    opened by pyup-bot 1
Releases(2022.9)
  • 2022.9(Oct 17, 2022)

  • 2022.8.2(Aug 24, 2022)

  • 2022.8(Aug 20, 2022)

  • 2022.6(Jun 12, 2022)

    What's Changed

    • . by @gerrishons in https://github.com/scalabli/quo/pull/91
    • updates by @gerrishons in https://github.com/scalabli/quo/pull/92
    • quo by @gerrishons in https://github.com/scalabli/quo/pull/93

    Full Changelog: https://github.com/scalabli/quo/compare/2022.5.3...2022.6

    Source code(tar.gz)
    Source code(zip)
  • 2022.5.3(May 14, 2022)

    What's Changed

    • under the hood optimizations by @gerrishons in https://github.com/scalabli/quo/pull/90

    Full Changelog: https://github.com/scalabli/quo/compare/2022.5.2...2022.5.3

    Source code(tar.gz)
    Source code(zip)
  • 2022.5.2(May 8, 2022)

    What's Changed

    • #Bug fixes by @gerrishons in https://github.com/scalabli/quo/pull/86

    Full Changelog: https://github.com/scalabli/quo/compare/2022.5.1...2022.5.2

    Source code(tar.gz)
    Source code(zip)
  • 2022.5.1(May 7, 2022)

    What's Changed

    • #SpinningWheel fix by @gerrishons in https://github.com/scalabli/quo/pull/85

    Full Changelog: https://github.com/scalabli/quo/compare/2022.5...2022.5.1

    Source code(tar.gz)
    Source code(zip)
  • 2022.5(May 1, 2022)

    What's Changed

    • Docs update by @gerrishons in https://github.com/scalabli/quo/pull/83
    • under the hood optimizations by @gerrishons in https://github.com/scalabli/quo/pull/84

    Full Changelog: https://github.com/scalabli/quo/compare/2022.4.6...2022.5

    Source code(tar.gz)
    Source code(zip)
  • 2022.4.6(Apr 24, 2022)

    What's Changed

    • quo.table.Table hotfix by @gerrishons in https://github.com/scalabli/quo/pull/82

    Full Changelog: https://github.com/scalabli/quo/compare/2022.4.5...2022.4.6

    Source code(tar.gz)
    Source code(zip)
  • 2022.4.5(Apr 23, 2022)

    What's Changed

    • some unicode characters not displaying on Windows fix by @gerrishons in https://github.com/scalabli/quo/pull/81

    Full Changelog: https://github.com/scalabli/quo/compare/2022.4.4...2022.4.5

    Source code(tar.gz)
    Source code(zip)
  • 2022.4.4(Apr 21, 2022)

    What's Changed

    • @scalabli🚀 by @gerrishons in https://github.com/scalabli/quo/pull/79

    Full Changelog: https://github.com/scalabli/quo/compare/2022.4.3...2022.4.4

    Source code(tar.gz)
    Source code(zip)
  • 2022.4.3(Apr 16, 2022)

    What's Changed

    • @scalabli🚀 by @gerrishons in https://github.com/scalabli/quo/pull/79

    Full Changelog: https://github.com/scalabli/quo/compare/2022.4.2...2022.4.3

    Source code(tar.gz)
    Source code(zip)
  • 2022.4.2(Apr 16, 2022)

  • 2022.4(Apr 1, 2022)

    Added :param:bg to all dialog boxes.

    • Added :param:multiline to :func:quo.dialog.In putBox
    • Added TextField as an aliase to :class:TextAr ea
    Source code(tar.gz)
    Source code(zip)
  • 2022.3.5(Mar 19, 2022)

  • 2022.3(Mar 11, 2022)

    Quo 2022.3

    Released on 2022-3-6

    Added

    • Added key binder :kbd:<any> enabling the user to press any key to exit the help page.
    • Introduced :class:quo.keys.Bind as an alias of :class:quo.keys.KeyBinder

    Changed

    • Changed :param:enable_system_elicit in favor of :param:system_prompt.
    • Changed :param:enable_suspend in favor of :param:suspend.

    Fixed

    • Optimized the help page.
    • Fixed Deprecated notice TypeError
    Source code(tar.gz)
    Source code(zip)
  • 2022.2(Feb 16, 2022)

    What's Changed

    • ci(Mergify): configuration update by @gerrishons in https://github.com/secretum-inc/quo/pull/39
    • Bug #12345 Scheduled daily dependency update on Sunday by @pyup-bot in https://github.com/secretum-inc/quo/pull/53
    • Bug #12345 Scheduled daily dependency update on Friday by @pyup-bot in https://github.com/secretum-inc/quo/pull/60

    Full Changelog: https://github.com/secretum-inc/quo/compare/2022.1...2022.2

    • Fixed minor bugs

    • Added quo.types.Number

    • Deprecated :param:password in favor of :param:hide

    • Deprecated quo.text.HTML in favor of quo.text.Text

    • Deprecated :param:r_elicit in favor of :param:rprompt

    • Deprecated quo.Suite in favor of quo.Console

    • Deprecated :param:validator in favor of :param:type

    • Added quo.Console.edit()

    • Added quo.Console.launch()

    • Added quo.Console.size()

    • Added quo.Console.encoding()

    • Added quo.Console.bell()

    • Added quo.Console.rule()

    • Added quo.Console.openfile()

    • Full support for Windows

    • Dropped support for python < 3.8

    Source code(tar.gz)
    Source code(zip)
  • 2022.1(Jan 14, 2022)

  • 2021.7(Dec 25, 2021)

  • 2021.6(Nov 20, 2021)

  • 2021.5.5.2(Oct 1, 2021)

  • 2021.4.5(Aug 22, 2021)

  • 2021.3.5(Jul 22, 2021)

  • 2021.5.dev12(Jun 1, 2021)

  • 2021.5.dev11(May 31, 2021)

  • 2021.2.dev9(Mar 3, 2021)

Owner
Secretum Inc.
Bright & Noble | Right & Global
Secretum Inc.
flora-dev-cli (fd-cli) is command line interface software to interact with flora blockchain.

Install git clone https://github.com/Flora-Network/fd-cli.git cd fd-cli python3 -m venv venv source venv/bin/activate pip install -e . --extra-index-u

null 14 Sep 11, 2022
A minimal and ridiculously good looking command-line-interface toolkit.

Pyceo Pyceo is a Python package for creating beautiful, composable, and ridiculously good looking command-line-user-interfaces without having to write

Juan-Pablo Scaletti 21 Mar 25, 2022
A supercharged AWS command line interface (CLI).

SAWS Motivation AWS CLI Although the AWS CLI is a great resource to manage your AWS-powered services, it's tough to remember usage of: 70+ top-level c

Donne Martin 5.1k Jan 5, 2023
Microsoft Azure CLI - Azure Command-Line Interface

A great cloud needs great tools; we're excited to introduce Azure CLI, our next generation multi-platform command line experience for Azure.

Microsoft Azure 3.4k Dec 30, 2022
moviepy-cli: Command line interface for MoviePy.

Moviepy-cli is designed to apply several video editing in a single command with Moviepy as an alternative to Video-cli.

Kentaro Wada 23 Jun 29, 2022
Program Command Line Interface (CLI) Sederhana: Pemesanan Nasi Goreng Hekel

Program ini merupakan aplikasi yang berjalan di dalam command line (terminal). Program ini menggunakan built-in library python yaitu argparse yang dapat menerima parameter saat program ini dijalankan melalui terminal atau CLI.

Habib Abdurrasyid 5 Nov 19, 2021
RSS reader client for CLI (Command Line Interface),

rReader is RSS reader client for CLI(Command Line Interface)

Lee JunHaeng 10 Dec 24, 2022
The Prisma Cloud CLI is a command line interface for Prisma Cloud by Palo Alto Networks.

Prisma Cloud CLI The Prisma Cloud CLI is a command line interface for Prisma Cloud by Palo Alto Networks. Support This project has been developed by P

Palo Alto Networks 13 Oct 14, 2022
A simple CLI based any Download Tool, that find files and let you stream or download thorugh WebTorrent CLI or Aria or any command tool

Privateer A simple CLI based any Download Tool, that find files and let you stream or download thorugh WebTorrent CLI or Aria or any command tool How

Shreyash Chavan 2 Apr 4, 2022
A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli.

ABOUT A command-line based, minimal torrent streaming client made using Python and Webtorrent-cli. Installation pip install -r requirements.txt It use

Janardon Hazarika 17 Dec 11, 2022
Juniper Command System is a Micro CLI Tool that allows you to manage your files, launch applications, as well as providing extra tools for OS Management.

Juniper Command System is a Micro CLI Tool that allows you to manage your files, launch applications, as well as providing extra tools for OS Management.

Juan Carlos Juárez 1 Feb 2, 2022
Unofficial Open Corporates CLI: OpenCorporates is a website that shares data on corporations under the copyleft Open Database License. This is an unofficial open corporates python command line tool.

Unofficial Open Corporates CLI OpenCorporates is a website that shares data on corporations under the copyleft Open Database License. This is an unoff

Richard Mwewa 30 Sep 8, 2022
Python Command Line Application (CLI) using Typer, SQLModel, Async-PostgrSQL, and FastAPI

pyflycli is a command-line interface application built with Typer that allows you to view flights above your location.

Kevin Zehnder 14 Oct 1, 2022
Easily turn single threaded command line applications into a fast, multi-threaded application with CIDR and glob support.

Easily turn single threaded command line applications into a fast, multi-threaded application with CIDR and glob support.

Michael Skelton 1k Jan 7, 2023
Squirrel - A cli program to track writing progress

Squirrel Very much a WIP project squirrel is a command line program that tracks you writing progress and gives you useful information and cute and pic

null 3 Mar 23, 2022
Command-line interface to PyPI Stats API to get download stats for Python packages

pypistats Python 3.6+ interface to PyPI Stats API to get aggregate download statistics on Python packages on the Python Package Index without having t

Hugo van Kemenade 140 Jan 3, 2023
A collection of command-line interface games written in python

Command Line Interface Python Games Collection of some starter python game projects for beginners How to play these games Clone this repository git cl

Paras Gupta 7 Jun 6, 2022
Command line interface to watch your childhood shows in hindi and english, designed with python

Sweet dreams: Most of your childhood shows Command line interface to watch your

Not Your Surya 3 Feb 13, 2022