chore: Release 1.3.4 #73
Merged
Conversation
This file contains 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
This PR was automatically created by [Update workflow](https://github.com/flox/floxdocs/actions/workflows/update.yml). Co-authored-by: FloxBot <[email protected]>
Bumps the all group with 2 updates in the / directory: [mkdocs-macros-plugin](https://github.com/fralau/mkdocs_macros_plugin) and [trove-classifiers](https://github.com/pypa/trove-classifiers). Updates `mkdocs-macros-plugin` from 1.2.0 to 1.3.6 <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/fralau/mkdocs-macros-plugin/blob/master/CHANGELOG.md">mkdocs-macros-plugin's changelog</a>.</em></p> <blockquote> <h2>1.3.6, 2024-10-17</h2> <ul> <li>Added: complete test framework, using pytest and Mkdocs-Test (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/244">#244</a>) A number of automated test cases are implemented.</li> <li>Changed: move from setup.py to pyproject.toml (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/250">#250</a>)</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/3a73707abd48c9df214646d57204cff854bbe98b"><code>3a73707</code></a> Migrate to pyproject.toml</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/99733bed5e62b9cc43cad1def816aefdf28651a1"><code>99733be</code></a> Demote info messages as debug (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/248">#248</a>)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/6a9a0e4f41e02a79f0e8f682f5329ed89f5dbb27"><code>6a9a0e4</code></a> Bump version number, for distribution (should solve <a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/247">#247</a>)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/32cd528114ff8b4203c5bfe216f32ca613266bc9"><code>32cd528</code></a> Test the hooks for external registration (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/237">#237</a>)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/16be58d9c64bf29ad489762fb30f6467eb192450"><code>16be58d</code></a> Migrate all tests toward the mkdocs-test framework (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/244">#244</a>)</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/59f82db2a60eae28832b5a1d44fb475f8c9e309f"><code>59f82db</code></a> Replacing local implementation of SuperDict by super-collections version</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/38b9681833fd06ae049c10fded1d33514b6c8d8e"><code>38b9681</code></a> Merge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/eebbbd1b6d9d587dbb36cb08d5aee35c5a8a34a7"><code>eebbbd1</code></a> Merge pull request <a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/246">#246</a> from dwreeves/add-pathspec-as-dependency</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/6d9982213eaca2fd44b9ddc101ed417371d829ed"><code>6d99822</code></a> Add <code>pathspec</code> as dependency</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/69577e12bc5d4bc4f59f276d599f39263fa4ea82"><code>69577e1</code></a> Separate standard DocProject and MarkdownPage classes</li> <li>Additional commits viewable in <a href="https://github.com/fralau/mkdocs_macros_plugin/compare/v1.2.0...v1.3.6">compare view</a></li> </ul> </details> <br /> Updates `trove-classifiers` from 2024.9.12 to 2024.10.16 <details> <summary>Commits</summary> <ul> <li>See full diff in <a href="https://github.com/pypa/trove-classifiers/commits">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 merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </details> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps the all group with 4 updates in the / directory: [mkdocs-include-markdown-plugin](https://github.com/mondeja/mkdocs-include-markdown-plugin), [mkdocs-macros-plugin](https://github.com/fralau/mkdocs_macros_plugin), [pymdown-extensions](https://github.com/facelessuser/pymdown-extensions) and [trove-classifiers](https://github.com/pypa/trove-classifiers). Updates `mkdocs-include-markdown-plugin` from 6.2.2 to 7.0.0 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/releases">mkdocs-include-markdown-plugin's releases</a>.</em></p> <blockquote> <h2>v7.0.0</h2> <h2>Breaking changes</h2> <h3>No longer installable on Python v3.8</h3> <p>Minimum Python version for installation is v3.9. Python v3.8 reached his end of life at 2024-10-07.</p> <h3>Comments are turned off by default</h3> <p>Before this release, the default value for <code>comments</code> argument of <code>include-markdown</code> directive was <code>true</code>. Now has been switched to <code>false</code>. This prevents some inconvenients, for example, trying to include one-line texts on table cells and list items.</p> <p>If you want the previous behaviour, configure <code>comments</code> as <code>true</code> in the global configuration:</p> <pre lang="yaml"><code>plugins: - include-markdown: comments: true </code></pre> <h3>Indented code blocks must be surrounded by newlines</h3> <p>Now mkdocs-include-markdown-plugin will only detect indented code blocks if are surrounded by newlines, conforming to <a href="https://spec.commonmark.org/0.28/#indented-code-blocks">CommonMark specification</a>.</p> <p>In the practice this means that you must surround indented code blocks with newlines or possible link targets URLs will be rewritten to work in relative files. For example, the next code is not treated as an indented code block any more and will break:</p> <pre lang="markdown"><code>Foo const auto lambda = []() { .... }; </code></pre> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/commit/76f01cc8efaed5d8dc6f304ecb42be92cd9ca96f"><code>76f01cc</code></a> Indented code blocks surrounded by newlines (<a href="https://redirect.github.com/mondeja/mkdocs-include-markdown-plugin/issues/234">#234</a>)</li> <li><a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/commit/7daca941478b187565b0c2724acd15f70c4112b3"><code>7daca94</code></a> Set <code>comments=false</code> as default for <code>include-markdown</code> directive (<a href="https://redirect.github.com/mondeja/mkdocs-include-markdown-plugin/issues/233">#233</a>)</li> <li><a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/commit/ef8888012115e5b982b142b112a2d92b1b9894ee"><code>ef88880</code></a> Python v3.8 EOL (<a href="https://redirect.github.com/mondeja/mkdocs-include-markdown-plugin/issues/232">#232</a>)</li> <li><a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/commit/2fee006ee3b068588894a14099d064a855c447b9"><code>2fee006</code></a> Update tooling (<a href="https://redirect.github.com/mondeja/mkdocs-include-markdown-plugin/issues/230">#230</a>)</li> <li>See full diff in <a href="https://github.com/mondeja/mkdocs-include-markdown-plugin/compare/v6.2.2...v7.0.0">compare view</a></li> </ul> </details> <br /> Updates `mkdocs-macros-plugin` from 1.3.6 to 1.3.7 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/fralau/mkdocs_macros_plugin/releases">mkdocs-macros-plugin's releases</a>.</em></p> <blockquote> <h2>v.1.3.7 With Test Framework</h2> <h2>1.3.7, 2024-10-18</h2> <ul> <li>Fixed: incompatibility with the d2 module (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/249">#249</a>)</li> </ul> <h2>1.3.6, 2024-10-17</h2> <ul> <li>Added: complete test framework, using pytest and Mkdocs-Test (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/244">#244</a>) A number of automated test cases are implemented.</li> <li>Changed: move from setup.py to pyproject.toml (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/250">#250</a>)</li> </ul> <h2>1.2.0, 2024-09-15</h2> <ul> <li>Added: three hooks <code>register_variables/macros/filters</code> to facilitate cooperation with other MkDocs plugins.</li> <li>Fixed: `define_env() was always required in module (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/191">#191</a>)</li> <li>Added: trace the case when no module is found (INFO)</li> <li>Improved documentation, particularly about HTML pages</li> <li>Added: parameters <code>j2_comment_start_string</code> and <code>j2_comment_end_string</code> to plugin's parameters, to specify alternate markers for comments.</li> <li>Added the multiline parameter <code>force_render_paths</code> in the config file, to specify directories or file patterns to be rendered for the case when <code>render_by_default = false</code> (the <code>render_macros</code> parameter in the YAML header of the page has the last word).</li> </ul> <h2>1.0.5, 2023-10-31</h2> <ul> <li>Added: git.short_tag (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/183">#183</a>)</li> <li>Added: Mermaid diagrams in the documentation (Readthedocs)</li> <li>Fixed: Changelog was no longer displayed (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/186">#186</a>)</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/fralau/mkdocs-macros-plugin/blob/master/CHANGELOG.md">mkdocs-macros-plugin's changelog</a>.</em></p> <blockquote> <h2>1.3.7, 2024-10-18</h2> <ul> <li>Fixed: incompatibility with the d2 module (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/249">#249</a>)</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/b906a368ecfd5cd25abcbea0a37f7a23944a8355"><code>b906a36</code></a> Bump version number</li> <li><a href="https://github.com/fralau/mkdocs-macros-plugin/commit/56418062b60c13faa4bbc15ab75fe6301c531fba"><code>5641806</code></a> Fixed incompatibility with d2 module (<a href="https://redirect.github.com/fralau/mkdocs_macros_plugin/issues/249">#249</a>)</li> <li>See full diff in <a href="https://github.com/fralau/mkdocs_macros_plugin/compare/v1.3.6...v1.3.7">compare view</a></li> </ul> </details> <br /> Updates `pymdown-extensions` from 10.11.2 to 10.12 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/facelessuser/pymdown-extensions/releases">pymdown-extensions's releases</a>.</em></p> <blockquote> <h2>10.12</h2> <ul> <li><strong>NEW</strong>: Blocks: Blocks extensions no longer considered in beta.</li> <li><strong>NEW</strong>: Details: Details is marked as "legacy" in documentation in favor of the new <code>pymdownx.blocks.details</code> approach.</li> <li><strong>NEW</strong>: Tabbed: Tabbed is marked as "legacy" in documentation in favor of the new <code>pymdownx.blocks.tab</code> approach.</li> <li><strong>NEW</strong>: Caption: Add new "blocks" style extension called Caption which helps with specifying figures with captions.</li> <li><strong>NEW</strong>: Emoji: Add a new <code>strict</code> option that will raise an exception if an emoji is used whose name has changed, removed, or never existed.</li> <li><strong>FIX</strong>: Emoji: Emoji links should be generated such that they point to the new CDN version.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/facelessuser/pymdown-extensions/commit/20be2fc43981a376923482d7be447a2e7c910cc3"><code>20be2fc</code></a> Update caption docs to use image example</li> <li><a href="https://github.com/facelessuser/pymdown-extensions/commit/2c7f8c02c6195d991d4d181665f7cd57cb95a649"><code>2c7f8c0</code></a> Add catpion extension (<a href="https://redirect.github.com/facelessuser/pymdown-extensions/issues/2492">#2492</a>)</li> <li><a href="https://github.com/facelessuser/pymdown-extensions/commit/b647b8de75d39d4047c9eddbf3af23adbf6c6de7"><code>b647b8d</code></a> Include white and black</li> <li><a href="https://github.com/facelessuser/pymdown-extensions/commit/3a89709010ff0bcf50bfe7aa7b1fb76b121031fa"><code>3a89709</code></a> Fix more sass stuff in doc style</li> <li><a href="https://github.com/facelessuser/pymdown-extensions/commit/e8ec7bffdd81f3ad27dc55ec8c3c4eecde37c2a4"><code>e8ec7bf</code></a> Update JS Doc deps and fix some links</li> <li><a href="https://github.com/facelessuser/pymdown-extensions/commit/0973681cda0d1b2146d0e19118eaeece42b90429"><code>0973681</code></a> Docs: Update JS deps</li> <li><a href="https://github.com/facelessuser/pymdown-extensions/commit/659b4d9298abd9fbae0c3c4144c133deb7963e05"><code>659b4d9</code></a> Add new strict option in the emoji extension (<a href="https://redirect.github.com/facelessuser/pymdown-extensions/issues/2488">#2488</a>)</li> <li>See full diff in <a href="https://github.com/facelessuser/pymdown-extensions/compare/10.11.2...10.12">compare view</a></li> </ul> </details> <br /> Updates `trove-classifiers` from 2024.10.16 to 2024.10.21.16 <details> <summary>Commits</summary> <ul> <li>See full diff in <a href="https://github.com/pypa/trove-classifiers/commits/2024.10.21.16">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 merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </details> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This also adds the D2 plugin for MkDocs so that we can use D2 to make diagrams. D2 is just generally a nicer language than Mermaid and renders better looking diagrams out of the box. --------- Co-authored-by: Rok Garbas <[email protected]>
|
CI needs re-run after actual release |
stahnma
approved these changes
Nov 12, 2024
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.
No description provided.