Skip to content

Update docs #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 8, 2025
Merged

Update docs #236

merged 1 commit into from
Apr 8, 2025

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Apr 8, 2025

This PR contains the following updates:

Package Type Update Change Age Adoption Passing Confidence
myst-parser dependencies minor >=0.13 -> >=0.19.1 age adoption passing confidence
myst_parser minor >=0.13 -> >=0.19.2 age adoption passing confidence
sphinx (source) dependencies minor >=7.0 -> >=7.4.7 age adoption passing confidence
sphinx (changelog) minor >=7.0 -> >=7.4.7 age adoption passing confidence
sphinx-autodoc-typehints (source) dependencies minor * -> >=1.25.3 age adoption passing confidence
sphinx-copybutton dependencies minor * -> >=0.5.2 age adoption passing confidence

Release Notes

ExecutableBookProject/MyST-Parser (myst-parser)

v0.19.1

🐛 FIX NoURI error in doc reference resolution, for texinfo builds (gh-pr:734)

v0.18.1

Full Changelog: v0.18.0...v0.18.1

  • ⬆️ UPGRADE: docutils 0.19 support in gh-pr:611
  • ✨ NEW: Add attrs_image (experimental) extension in gh-pr:620
    • e.g. ![image](image.png){#id .class width=100px}
    • See: Optional syntax section
    • Important: This is an experimental extension, and may change in future releases

v0.18.0

Full Changelog: v0.17.2...v0.18.0

This release adds support for Sphinx v5 (dropping v3), restructures the code base into modules, and also restructures the documentation, to make it easier for developers/users to follow.

It also introduces document-level configuration via the Markdown front-matter, under the myst key.
See the Local configuration section for more information.

Breaking changes

This should not be breaking, for general users of the sphinx extension (with sphinx>3),
but will be for anyone directly using the Python API, mainly just requiring changes in import module paths.

The to_docutils, to_html, to_tokens (from myst_parser/main.py) and mock_sphinx_env/parse (from myst_parser.sphinx_renderer.py) functions have been removed, since these were primarily for internal testing.
Instead, for single page builds, users should use the docutils parser API/CLI (see ),
and for testing, functionality has been moved to https://github.com/chrisjsewell/sphinx-pytest.

The top-level html_meta and substitutions front-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of the myst config, e.g.

v0.17.2

Full Changelog: v0.17.1...v0.17.2

  • ♻️ REFACTOR: Replace attrs by dataclasses for configuration (gh-pr:557)

v0.17.0

This release contains a number of breaking improvements.

Full Changelog: v0.16.1...v0.17.0

‼️ Markdown link resolution improvements

WARNING: This is a breaking change for links that rely on auto-generated anchor links. You should now manually enable auto-generated anchor links if you see errors like WARNING reference target not found.

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.md#anchor)
  3. A link to an internal sphinx cross-reference, e.g. [text](my-reference)

an additional situation is now supported:

  1. 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=("http", "https"), sets what URL schemes are treated as (1)
  • myst_ref_domains=("std", "py"), sets what Sphinx reference domains are checked, when handling (3)

See Markdown Links and Referencing for more information.

‼️ Dollarmath is now disabled by default

WARNING: This is a breaking change for dollar math. You should now manually enable dollar math (see below).

The default configuration is now myst_enable_extensions=(), instead of myst_enable_extensions=("dollarmath",).
If you are using math enclosed in $ or $$ in your documents, you should enable dollarmath explicitly.

See Dollar delimited math 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 for more information.

The myst_gfm_only=True configuration sets up specific configuration, to enable compliance only with GitHub-flavored Markdown, 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:

v0.16.1

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

v0.15.2

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

v0.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 = ["myst.mathjax"].

v0.15.0

Upgraded to sphinx v4 ⬆️

A principe change in this release is to updates the requirements of myst-parser from sphinx>=2,<4 to sphinx>=3,<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 for further information.

Set URL scheme defaults ‼️

The myst_url_schemes default is now: ("http", "https", "mailto", "ftp").
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).

Thanks to gh-user:jpmckinney!

v0.14.0

Upgrade to markdown-it-py v1.0 ⬆️

This release updates the code-base to fully support the markdown-it-py v1.0.0 release.
In particular for users, this update alters the parsing of tables to be consistent with the Github Flavoured Markdown (GFM) specification.

New Features ✨

  • Task lists utilise the markdown-it-py tasklists plugin, and are applied to Markdown list items starting with [ ] or [x].

    - [ ] An item that needs doing
- [x] An item that is complete

    Add "tasklist" to the myst_enable_extensions configuration to enable.

    See the optional syntax guide for further information.

  • The sub-ref role has been added for use identical to ReST's |name| syntax.

    This allows one to access Sphinx's built-in |today|, |release| and |version| substitutions, and also introduces two new substitutions: wordcount-words and wordcount-minutes, computed by the markdown-it-py wordcount_plugin.

    > {sub-ref}`today` | {sub-ref}`wordcount-words` words | {sub-ref}`wordcount-minutes` min read

    See the roles syntax guide for further information.

  • The dmath_double_inline configuration option allows display math (i.e. $$) within an inline context.
    See the math syntax guide for further information.

Remove v0.13 deprecations ‼️

The deprecations made to extension configurations and colon fences in 0.13.0 (see below) have now been removed:

  • Configuration variables: myst_admonition_enable, myst_figure_enable, myst_dmath_enable, myst_amsmath_enable, myst_deflist_enable, myst_html_img_enable
  • :::{admonition,class} -> :::{admonition}\n:class: class
  • :::{figure} -> :::{figure-md}
Fix extraction of nested footnotes 🐛

Previously footnote definitions in block elements like lists would crash the parsing:

- [^e]: footnote definition in a block element

These are now correctly extracted.

v0.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:

```{note}

v0.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 gh-user: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 for more information.

v0.13.3

Minor fixes:

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

v0.13.2

✨ NEW: Add html_admonition extension

: By adding "html_admonition" to myst_enable_extensions, you can enable parsing of <div class="admonition"> HTML blocks to sphinx admonitions.
: This is helpful when you care about viewing the "source" Markdown, such as in Jupyter Notebooks.
: For example:

<div class="admonition note" name="html-admonition">
<p class="title">This is the **title**</p>
This is the *content*
</div>

: See the optional syntax guide 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 <hr> in HTML.
: See the typography guide 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 gh-user:akhmerov, gh-user:tfiers)

v0.13.1

👌 Directives can now be used for inline substitutions, e.g.

executablebooks/MyST-Parser (myst_parser)

v0.19.2

Compare Source

✨ NEW: Add myst_fence_as_directive config (gh-pr:742)

Setting the following config, for example:

extensions = ["myst_parser", "sphinxcontrib.mermaid"]
myst_fence_as_directive = ["mermaid"]

v0.19.1

Compare Source

🐛 FIX NoURI error in doc reference resolution, for texinfo builds (gh-pr:734)

v0.19.0

Compare Source

This release brings a number of exciting new features, improvements, and upgrades 🎉

Full Changelog: v0.18.1...v0.19.0

📚 Rewritten documentation

The documentation has been almost completely rewritten,
with a clearer structure, many more examples, rich hover tips, and a new live preview page (powered by pyscript, gh-pr:717).

The code base API is also now fully documented by sphinx-autodoc2, which even allows for MyST docstrings! (gh-pr:704).

⬆️ Add Sphinx 6 support, drop Sphinx 4

The code base has been updated to support sphinx v6, and is no longer tested against sphinx v4 (gh-pr:664)

📄 Extended docutils (single-page) support

The docutils parser now supports many more features, and improvements to support live previews:

  • myst_suppress_warnings option added, mirroring Sphinx, to suppress MyST warnings (gh-pr:655)
  • myst_meta_html and myst_substitutions options are now supported (gh-pr:672)
  • myst_heading_anchors option is now supported (gh-pr:678)
  • Math block labels syntax is now supported (gh-pr:668)
  • Missing directive/role errors errors are now suppressible warnings (gh-pr:687)
  • Non-fatal directive parsing errors are now suppressible warnings (gh-pr:682)
  • Most of the extended markdown syntax below is also supported
🔗 Extended Markdown links

See the Extended Markdown links section for the full guide.

You can now use standard Markdown link syntax to reference many different types of targets, in a more consistent way.

  • [text](relative/path/myfile.md) work as previously, to link to files,
    but they can also be relative to source directory: [text](/path/from/srcdir/myfile.md).
    You can also use <project:file.md>
  • <path:myfile.txt> will link specifically to a downloadable file
  • [text](#target) or <project:#target> will link (in order of priority) to any local target, local heading anchor, target in the same project, or intersphinx (inventory) target
  • [text](inv:name:domain:type#target) will link specifically to a Sphinx inventory target, or to any inventory <inv:#target>, and can even use * wildcards like <inv:*:*:*#*.target>
    • This can even be used in docutils, with the new myst_inventories config option
    • The myst-inv CLI makes it easy to find the correct inventory target

:::{tip}
It is advised (although not immediately necessary) to prefix all internal references with #.
For example, [...](my-reference), should be changed to [...](#my-reference).
:::

{} Attributes syntax

The attrs_inline and attrs_block extensions allow for common Markdown syntaxes to be extended with greater control over the output.

For example, you can now add classes, ids, and other attributes to inline code, images, and links, as well as to code blocks and directives.

  • Inline code: `a = 1`{#id .class l=python}
  • Images: ![image](image.png){#id .class width=100px}
  • Text spans: [some text]{#id .class}

A paragraph block can have attributes too:

{#id .class}
This is a paragraph with an id and class

A code fence can be given line numbers and line emphasis:

{#id .class lineno-start=1 emphasize-lines="2,3"}
```python
a = 1
b = 2
c = 3
```

A definition list can be turned into a glossary, with referenceable terms:

{.glossary}
term name
: Definition of the term

Quote blocks can be given an attribution:

{attribution="Chris Sewell"}
> My quote
👌 Miscellaneous improvements
  • Nested headings (e.g. inside directives) are now allowed in MyST and are correctly rendered in HTML (gh-pr:711)
  • The colon_fence extension now renders internal content as MyST, rather than as a code block (gh-pr:713)
  • The include directive in MyST documents now supports a :heading-offset: option, to offset the heading levels in the included document
  • The myst_heading_slug_func option now supports setting a str which points to a fully qualified function name, e.g. "module.path.func" (gh-pr:696)
  • The myst_enable_checkboxes option allows for task list checkboxes to be enabled/disabled (gh-pr:686)
Additional contributions
  • 🐛 FIX: Remove unnecessary assert in gh-pr:659, thanks to gh-user:n-peugnet
  • 🔧 ci(deps): setup dependabot (gh-pr:669), thanks to gh-user:mmorel-35
  • 🔧: Depend on typing_extensions only on Python<3.8 in gh-pr:642, thanks to gh-user:hukkin

v0.18.1

Compare Source

Full Changelog: v0.18.0...v0.18.1

  • ⬆️ UPGRADE: docutils 0.19 support in gh-pr:611
  • ✨ NEW: Add attrs_image (experimental) extension in gh-pr:620
    • e.g. ![image](image.png){#id .class width=100px}
    • See: Optional syntax section
    • Important: This is an experimental extension, and may change in future releases

v0.18.0

Compare Source

Full Changelog: v0.17.2...v0.18.0

This release adds support for Sphinx v5 (dropping v3), restructures the code base into modules, and also restructures the documentation, to make it easier for developers/users to follow.

It also introduces document-level configuration via the Markdown front-matter, under the myst key.
See the Local configuration section for more information.

Breaking changes

This should not be breaking, for general users of the sphinx extension (with sphinx>3),
but will be for anyone directly using the Python API, mainly just requiring changes in import module paths.

The to_docutils, to_html, to_tokens (from myst_parser/main.py) and mock_sphinx_env/parse (from myst_parser.sphinx_renderer.py) functions have been removed, since these were primarily for internal testing.
Instead, for single page builds, users should use the docutils parser API/CLI (see ),
and for testing, functionality has been moved to https://github.com/chrisjsewell/sphinx-pytest.

The top-level html_meta and substitutions front-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of the myst config, e.g.

v0.17.2

Compare Source

Full Changelog: v0.17.1...v0.17.2

  • ♻️ REFACTOR: Replace attrs by dataclasses for configuration (gh-pr:557)

v0.17.1

Compare Source

Full Changelog: v0.17.0...v0.17.1

  • 🐛 FIX: Heading anchor resolution for parallel builds (gh-pr:525)
  • 🔧 MAINTAIN: Move packaging from setuptools to flit (gh-pr:553)
  • 🔧 MAINTAIN: Directly specify attrs dependency (gh-pr:555)

v0.17.0

Compare Source

This release contains a number of breaking improvements.

Full Changelog: v0.16.1...v0.17.0

‼️ Markdown link resolution improvements

WARNING: This is a breaking change for links that rely on auto-generated anchor links. You should now manually enable auto-generated anchor links if you see errors like WARNING reference target not found.

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.md#anchor)
  3. A link to an internal sphinx cross-reference, e.g. [text](my-reference)

an additional situation is now supported:

  1. 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=("http", "https"), sets what URL schemes are treated as (1)
  • myst_ref_domains=("std", "py"), sets what Sphinx reference domains are checked, when handling (3)

See Markdown Links and Referencing for more information.

‼️ Dollarmath is now disabled by default

WARNING: This is a breaking change for dollar math. You should now manually enable dollar math (see below).

The default configuration is now myst_enable_extensions=(), instead of myst_enable_extensions=("dollarmath",).
If you are using math enclosed in $ or $$ in your documents, you should enable dollarmath explicitly.

See Dollar delimited math 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 for more information.

The myst_gfm_only=True configuration sets up specific configuration, to enable compliance only with GitHub-flavored Markdown, 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:

v0.16.1

Compare Source

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

v0.16.0

Compare Source

This release contains a number of exciting improvements:

Upgrade of Markdown parser

markdown-it-py has been upgraded to v2.0.0.
This upgrade brings full compliance with the CommonMark v0.30 specification.

Additionally, mdit-py-plugins has been upgraded to 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:

(a bc   |@&#8203;<>*./_-+:)=

v0.15.2

Compare Source

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

v0.15.1

Compare Source

👌 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 = ["myst.mathjax"].

v0.15.0

Compare Source

Upgraded to sphinx v4 ⬆️

A principe change in this release is to updates the requirements of myst-parser from sphinx>=2,<4 to sphinx>=3,<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 for further information.

Set URL scheme defaults ‼️

The myst_url_schemes default is now: ("http", "https", "mailto", "ftp").
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).

Thanks to gh-user:jpmckinney!

v0.14.0

Compare Source

Upgrade to markdown-it-py v1.0 ⬆️

This release updates the code-base to fully support the markdown-it-py v1.0.0 release.
In particular for users, this update alters the parsing of tables to be consistent with the Github Flavoured Markdown (GFM) specification.

New Features ✨

  • Task lists utilise the markdown-it-py tasklists plugin, and are applied to Markdown list items starting with [ ] or [x].

    - [ ] An item that needs doing
- [x] An item that is complete

    Add "tasklist" to the myst_enable_extensions configuration to enable.

    See the optional syntax guide for further information.

  • The sub-ref role has been added for use identical to ReST's |name| syntax.

    This allows one to access Sphinx's built-in |today|, |release| and |version| substitutions, and also introduces two new substitutions: wordcount-words and wordcount-minutes, computed by the markdown-it-py wordcount_plugin.

    > {sub-ref}`today` | {sub-ref}`wordcount-words` words | {sub-ref}`wordcount-minutes` min read

    See the roles syntax guide for further information.

  • The dmath_double_inline configuration option allows display math (i.e. $$) within an inline context.
    See the math syntax guide for further information.

Remove v0.13 deprecations ‼️

The deprecations made to extension configurations and colon fences in 0.13.0 (see below) have now been removed:

  • Configuration variables: myst_admonition_enable, myst_figure_enable, myst_dmath_enable, myst_amsmath_enable, myst_deflist_enable, myst_html_img_enable
  • :::{admonition,class} -> :::{admonition}\n:class: class
  • :::{figure} -> :::{figure-md}
Fix extraction of nested footnotes 🐛

Previously footnote definitions in block elements like lists would crash the parsing:

- [^e]: footnote definition in a block element

These are now correctly extracted.

v0.13.7

Compare Source

👌 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:

```{note}

v0.13.6

Compare Source

🐛 FIX: docutils v0.17 compatibility

v0.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 gh-user: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 for more information.

v0.13.3

Compare Source

Minor fixes:

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

v0.13.2

Compare Source

✨ NEW: Add html_admonition extension

: By adding "html_admonition" to myst_enable_extensions, you can enable parsing of <div class="admonition"> HTML blocks to sphinx admonitions.
: This is helpful when you care about viewing the "source" Markdown, such as in Jupyter Notebooks.
: For example:

<div class="admonition note" name="html-admonition">
<p class="title">This is the **title**</p>
This is the *content*
</div>

: See the optional syntax guide 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 <hr> in HTML.
: See the typography guide 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 gh-user:akhmerov, gh-user:tfiers)

v0.13.1

Compare Source

👌 Directives can now be used for inline substitutions, e.g.

sphinx-doc/sphinx (sphinx)

v7.4.7: Sphinx 7.4.7

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.4.6: Sphinx 7.4.6

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.4.5: Sphinx 7.4.5

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.4.4: Sphinx 7.4.4

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.4.3: Sphinx 7.4.3

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.4.2: Sphinx 7.4.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.4.1: Sphinx 7.4.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.4.0: Sphinx 7.4.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.3.7: Sphinx 7.3.7

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.3.6: Sphinx 7.3.6

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.3.5: Sphinx 7.3.5

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.2.6: Sphinx 7.2.6

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.2.5: Sphinx 7.2.5

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.2.4: Sphinx 7.2.4

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.2.3: Sphinx 7.2.3

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.2.2: Sphinx 7.2.2

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.2.1: Sphinx 7.2.1

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.2.0: Sphinx 7.2.0

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.1.2: Sphinx 7.1.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.1.1: Sphinx 7.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.0.1

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

tox-dev/sphinx-autodoc-typehints (sphinx-autodoc-typehints)

v1.25.3

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.25.2...1.25.3

v1.25.2

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.25.1...1.25.2

v1.25.1

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.25.0...1.25.1

v1.25.0

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.24.1...1.25.0

v1.24.0

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.23.3...1.24.0

v1.21.8

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.21.7...1.27.8

v1.21.3

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.21.2...1.21.3

v1.21.2

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.21.1...1.21.2

v1.21.1

Compare Source

What's Changed

New Contributors

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.21.0...1.21.1

v1.21.0

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.20.2...1.21.0

v1.20.2

Compare Source

What's Changed

New Contributors

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.20.1...1.20.2

v1.20.1

Compare Source

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.20.0...1.20.1

v1.20.0

Compare Source

What's Changed

New Contributors

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.19.5...1.20.0

v1.19.5

Compare Source

What's Changed

New Contributors

Full Changelog: tox-dev/sphinx-autodoc-typehints@1.19.4...1.19.5

v1.19.4

[Compare Source](https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/compare/1.19.3...1.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@lucascolley lucascolley added the dependencies Pull requests that update a dependency file label Apr 8, 2025
@lucascolley lucascolley merged commit d3801e7 into main Apr 8, 2025
9 checks passed
@renovate renovate bot deleted the renovate/docs branch April 8, 2025 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

dependencies Pull requests that update a dependency file

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@lucascolley