Repository navigation
Replace figurative verbs and idioms in the guide, installation and parameter-tuning pages - #126
Merged
Merged
Conversation
Updates the requirements on [myst-parser](https://github.com/executablebooks/MyST-Parser) to permit the latest version. - [Release notes](https://github.com/executablebooks/MyST-Parser/releases) - [Changelog](https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md) - [Commits](executablebooks/MyST-Parser@v3.0.0...v5.1.0) --- updated-dependencies: - dependency-name: myst-parser dependency-version: 5.1.0 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com>
Updates the requirements on [myst-parser](https://github.com/executablebooks/MyST-Parser) to permit the latest version. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/executablebooks/MyST-Parser/releases">myst-parser's releases</a>.</em></p> <blockquote> <h2>v5.1.0</h2> <h2>✨ New Features</h2> <ul> <li>✨ Add <code>"alert"</code> syntax extension for <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts">GFM alerts</a> (e.g. <code>> [!NOTE]</code>), see <a href="https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#alerts-github-style-callouts">docs</a> by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1128">#1128</a></li> <li>✨ Add <code>"gfm_autolink"</code> syntax extension for <a href="https://github.github.com/gfm/#autolinks-extension-">GFM autolinks</a>, see <a href="https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#gfm-autolinks">docs</a> by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1128">#1128</a></li> <li>✨ Add <code>myst_strikethrough_single_tilde</code> <a href="https://myst-parser.readthedocs.io/en/latest/configuration.html">config option</a> to allow single tilde (<code>~</code>) for strikethrough by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1128">#1128</a></li> <li>✨ Add <code>myst_colon_fence_exact_match</code> <a href="https://myst-parser.readthedocs.io/en/latest/configuration.html">config option</a> to require the closing colon fence to have exactly the same number of colons as the opening, see <a href="https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#code-fences-using-colons">docs</a> by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1128">#1128</a></li> </ul> <h2>👌 Improvements</h2> <ul> <li>👌 Update <code>myst_gfm_only</code> mode to use the unified <code>gfm_plugin</code>, which now includes GFM autolinks, alerts, and improved strikethrough/tasklist handling by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1128">#1128</a></li> <li>👌 Improve MathJax 4 compatibility for Sphinx 9 by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1110">#1110</a></li> <li>👌 Stop directive-option parsing at colon fences, fixing nested colon fence directives by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1133">#1133</a></li> </ul> <h2>🐛 Bug Fixes</h2> <ul> <li>🐛 Use docname instead of source path in warning locations by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1114">#1114</a></li> <li>🐛 Correctly encode <code>&</code> in Markdown URLs by not HTML-escaping <code>refuri</code> by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1126">#1126</a></li> <li>🐛 Fix <code>RemovedInSphinx10Warning</code> for inventory item iteration by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1129">#1129</a></li> <li>🐛 Pin <code>mdit-py-plugins>=0.6.1</code> for nested field list fix by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1134">#1134</a></li> </ul> <h2>⬆️ Dependency Upgrades</h2> <ul> <li>⬆️ Upgrade to <code>markdown-it-py~=4.2</code> and <code>mdit-py-plugins~=0.6</code> by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1128">#1128</a></li> <li>⬆️ Update pygments requirement from <code><2.20</code> to <code><2.21</code> by <a href="https://github.com/chrisjsewell"><code>@chrisjsewell</code></a> in <a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1117">#1117</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/mb"><code>@mb</code></a> made their first contribution in <a href="https://redirect.github.com/executablebooks/MyST-Parser/pull/1126">executablebooks/MyST-Parser#1126</a></li> <li><a href="https://github.com/Bizordec"><code>@Bizordec</code></a> made their first contribution in <a href="https://redirect.github.com/executablebooks/MyST-Parser/pull/1114">executablebooks/MyST-Parser#1114</a></li> <li><a href="https://github.com/ilia-kats"><code>@ilia-kats</code></a> made their first contribution in <a href="https://redirect.github.com/executablebooks/MyST-Parser/pull/1110">executablebooks/MyST-Parser#1110</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/executablebooks/MyST-Parser/compare/v5.0.0...v5.1.0">https://github.com/executablebooks/MyST-Parser/compare/v5.0.0...v5.1.0</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md">myst-parser's changelog</a>.</em></p> <blockquote> <h2>5.1.0 - 2026-05-13</h2> <h3>✨ New Features</h3> <ul> <li>✨ Add <code>"alert"</code> syntax extension for <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts">GFM alerts</a> (e.g. <code>> [!NOTE]</code>), see <a href="https://github.com/executablebooks/MyST-Parser/blob/master/syntax/alerts"></a> by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1128">gh-pr:1128</a></li> <li>✨ Add <code>"gfm_autolink"</code> syntax extension for <a href="https://github.github.com/gfm/#autolinks-extension-">GFM autolinks</a>, see <a href="https://github.com/executablebooks/MyST-Parser/blob/master/syntax/gfm-autolink"></a> by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1128">gh-pr:1128</a></li> <li>✨ Add <code>myst_strikethrough_single_tilde</code> <a href="https://github.com/executablebooks/MyST-Parser/blob/master/sphinx/config-options">config option</a> to allow single tilde (<code>~</code>) for strikethrough by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1128">gh-pr:1128</a></li> <li>✨ Add <code>myst_colon_fence_exact_match</code> <a href="https://github.com/executablebooks/MyST-Parser/blob/master/sphinx/config-options">config option</a> to require the closing colon fence to have exactly the same number of colons as the opening, see <a href="https://github.com/executablebooks/MyST-Parser/blob/master/syntax/colon_fence"></a> by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1128">gh-pr:1128</a></li> </ul> <h3>👌 Improvements</h3> <ul> <li>👌 Update <a href="https://github.com/executablebooks/MyST-Parser/blob/master/sphinx/config-options"><code>myst_gfm_only</code></a> mode to use the unified <code>gfm_plugin</code>, which now includes GFM autolinks, alerts, and improved strikethrough/tasklist handling by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1128">gh-pr:1128</a></li> <li>👌 Improve MathJax 4 compatibility for Sphinx 9 by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1110">gh-pr:1110</a></li> <li>👌 Stop directive-option parsing at colon fences, fixing nested colon fence directives by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1133">gh-pr:1133</a></li> </ul> <h3>🐛 Bug Fixes</h3> <ul> <li>🐛 Use docname instead of source path in warning locations by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1114">gh-pr:1114</a></li> <li>🐛 Correctly encode <code>&</code> in Markdown URLs by not HTML-escaping <code>refuri</code> by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1126">gh-pr:1126</a></li> <li>🐛 Fix <code>RemovedInSphinx10Warning</code> for inventory item iteration by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1129">gh-pr:1129</a></li> <li>🐛 Pin <code>mdit-py-plugins>=0.6.1</code> for nested field list fix by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1134">gh-pr:1134</a></li> </ul> <h3>⬆️ Dependency Upgrades</h3> <ul> <li>⬆️ Upgrade to <code>markdown-it-py~=4.2</code> and <code>mdit-py-plugins~=0.6</code> by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1128">gh-pr:1128</a></li> <li>⬆️ Update pygments requirement from <code><2.20</code> to <code><2.21</code> by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1117">gh-pr:1117</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/executablebooks/MyST-Parser/compare/v5.0.0...v5.1.0">v5.0.0...v5.1.0</a></p> <h2>5.0.0 - 2026-01-15</h2> <p>This release significantly bumps the supported versions of core dependencies:</p> <h3>‼️ Breaking Changes</h3> <p>This release updates the minimum supported versions:</p> <ul> <li><strong>Python</strong>: <code>>=3.11</code> (dropped Python 3.10, tests up to 3.14)</li> <li><strong>Sphinx</strong>: <code>>=8,<10</code> (dropped Sphinx 7, added Sphinx 9)</li> <li><strong>Docutils</strong>: <code>>=0.20,<0.23</code> (dropped docutils 0.19, added docutils 0.22)</li> <li><strong>markdown-it-py</strong>: <code>~=4.0</code> (upgraded from v3)</li> </ul> <h3>⬆️ Dependency Upgrades</h3> <ul> <li>⬆️ Upgrade to markdown-it-py v4 by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1060">gh-pr:1060</a></li> <li>⬆️ Drop Python 3.10 and Sphinx 7 by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1059">gh-pr:1059</a></li> <li>⬆️ Drop docutils 0.19 by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1061">gh-pr:1061</a></li> <li>⬆️ Add support for Python 3.14 by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1075">gh-pr:1075</a></li> <li>⬆️ Support Sphinx v9 by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1076">gh-pr:1076</a></li> <li>⬆️ Allow docutils 0.22 by <a href="gh-user:chrisjsewell">gh-user:chrisjsewell</a> in <a href="gh-pr:1084">gh-pr:1084</a></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/2871eb95750873ccec2c4ab1dac0568815b64ca5"><code>2871eb9</code></a> 🚀 Release v5.1.0 (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1135">#1135</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/cc5db37fd06445d7d023f7f2e0c2c073730be9cf"><code>cc5db37</code></a> 🐛 FIX: Pin mdit-py-plugins>=0.6.1 for nested field list fix (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1134">#1134</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/4ce57f94af31de53c8790ccfffa3107c64241d0d"><code>4ce57f9</code></a> 👌 Stop directive-option parsing at colon fences (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1133">#1133</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/cfcc3278f9e8c7508aae4cea82f1dd9c5c111183"><code>cfcc327</code></a> ⬆️ Bump mypy from 2.0.0 to 2.1.0 (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1131">#1131</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/691738c3d897f82577440e18079d8b990edb8e34"><code>691738c</code></a> ⬆️ Bump ruff from 0.15.10 to 0.15.12 (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1132">#1132</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/0fb1ae983d7b0df68bd02a9f77b0bc45057edbaf"><code>0fb1ae9</code></a> 👌 IMPROVE: MathJax 4 compatibility (Sphinx 9) (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1110">#1110</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/f153b4b8ae68cbe77b41942147cf5cb6464168f0"><code>f153b4b</code></a> ⬆️ Bump actions/setup-python from 5 to 6 (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1092">#1092</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/93acf8dae502aba484b14a1d291366fc21f839e6"><code>93acf8d</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1095">#1095</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/a5f1d6963bc3ee361d25309a24ccc42e6860fd54"><code>a5f1d69</code></a> ⬆️ Update pygments requirement from <2.20 to <2.21 (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1117">#1117</a>)</li> <li><a href="https://github.com/executablebooks/MyST-Parser/commit/838129687219517e31a395736397c957d93532dd"><code>8381296</code></a> 🐛 FIX: Use docname instead of source path in warning locations (<a href="https://redirect.github.com/executablebooks/MyST-Parser/issues/1114">#1114</a>)</li> <li>Additional commits viewable in <a href="https://github.com/executablebooks/MyST-Parser/compare/v3.0.0...v5.1.0">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>
…rameter-tuning pages
Documentation build overview
47 files changed ·
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces figurative verbs and idioms with literal wording (for example "wins" with "is kept", "carries" for a held attribute with "has", "picks" with "selects"). Only comments, docstrings and prose change; no code, identifier, link or heading changes.