Skip to content

Bump mkdocs-macros-plugin from 1.0.5 to 1.3.7 #1229

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.

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

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Jul 7, 2025

Bumps mkdocs-macros-plugin from 1.0.5 to 1.3.7.

Release notes

Sourced from mkdocs-macros-plugin's releases.

v.1.3.7 With Test Framework

1.3.7, 2024-10-18

  • Fixed: incompatibility with the d2 module (#249)

1.3.6, 2024-10-17

  • Added: complete test framework, using pytest and Mkdocs-Test (#244) A number of automated test cases are implemented.
  • Changed: move from setup.py to pyproject.toml (#250)

1.2.0, 2024-09-15

  • Added: three hooks register_variables/macros/filters to facilitate cooperation with other MkDocs plugins.
  • Fixed: `define_env() was always required in module (#191)
  • Added: trace the case when no module is found (INFO)
  • Improved documentation, particularly about HTML pages
  • Added: parameters j2_comment_start_string and j2_comment_end_string to plugin's parameters, to specify alternate markers for comments.
  • Added the multiline parameter force_render_paths in the config file, to specify directories or file patterns to be rendered for the case when render_by_default = false (the render_macros parameter in the YAML header of the page has the last word).

1.0.5, 2023-10-31

  • Added: git.short_tag (#183)
  • Added: Mermaid diagrams in the documentation (Readthedocs)
  • Fixed: Changelog was no longer displayed (#186)
Changelog

Sourced from mkdocs-macros-plugin's changelog.

1.3.7, 2024-10-18

  • Fixed: incompatibility with the d2 module (#249)

1.3.6, 2024-10-17

  • Added: complete test framework, using pytest and Mkdocs-Test (#244) A number of automated test cases are implemented.
  • Changed: move from setup.py to pyproject.toml (#250)

1.2.0, 2024-09-15

  • Added: three hooks register_variables/macros/filters to facilitate cooperation with other MkDocs plugins.
  • Fixed: `define_env() was always required in module (#191)
  • Added: trace the case when no module is found (INFO)
  • Improved documentation, particularly about HTML pages
  • Added: parameters j2_comment_start_string and j2_comment_end_string to plugin's parameters, to specify alternate markers for comments.
  • Added the multiline parameter force_render_paths in the config file, to specify directories or file patterns to be rendered for the case when render_by_default = false (the render_macros parameter in the YAML header of the page has the last word).
Commits
  • b906a36 Bump version number
  • 5641806 Fixed incompatibility with d2 module (#249)
  • 3a73707 Migrate to pyproject.toml
  • 99733be Demote info messages as debug (#248)
  • 6a9a0e4 Bump version number, for distribution (should solve #247)
  • 32cd528 Test the hooks for external registration (#237)
  • 16be58d Migrate all tests toward the mkdocs-test framework (#244)
  • 59f82db Replacing local implementation of SuperDict by super-collections version
  • 38b9681 Merge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master
  • eebbbd1 Merge pull request #246 from dwreeves/add-pathspec-as-dependency
  • Additional commits viewable in compare view

Dependabot compatibility score

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 commands and options

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 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)

Summary by Sourcery

Upgrade mkdocs-macros-plugin to version 1.3.7 to introduce integration hooks, extend configuration options, strengthen testing, and address compatibility issues.

New Features:

  • Add register_variables, macros, and filters hooks for plugin integration
  • Introduce j2_comment_start_string and j2_comment_end_string parameters to customize comment markers
  • Add force_render_paths configuration to specify files or directories for rendering when render_by_default is disabled
  • Add git.short_tag macro

Bug Fixes:

  • Fix incompatibility with the d2 module
  • Resolve issue requiring define_env() in modules
  • Fix changelog display issue
  • Demote certain informational log messages to debug level

Build:

  • Migrate packaging from setup.py to pyproject.toml

Documentation:

  • Improve HTML documentation pages and add Mermaid diagrams

Tests:

  • Implement a complete test framework using pytest and Mkdocs-Test
  • Migrate tests to mkdocs-test and add tests for external registration hooks

Bumps [mkdocs-macros-plugin](https://github.com/fralau/mkdocs_macros_plugin) from 1.0.5 to 1.3.7.
- [Release notes](https://github.com/fralau/mkdocs_macros_plugin/releases)
- [Changelog](https://github.com/fralau/mkdocs-macros-plugin/blob/master/CHANGELOG.md)
- [Commits](fralau/mkdocs-macros-plugin@v1.0.5...v1.3.7)

---
updated-dependencies:
- dependency-name: mkdocs-macros-plugin
  dependency-version: 1.3.7
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Jul 7, 2025

The reviewers field in the dependabot.yml file will be removed soon. Please use the code owners file to specify reviewers for Dependabot PRs. For more information, see this blog post.

@dependabot dependabot bot requested a review from aw-was-here July 7, 2025 18:21
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Jul 7, 2025
Copy link

sourcery-ai bot commented Jul 7, 2025

Reviewer's Guide

This PR updates the mkdocs-macros-plugin dependency from v1.0.5 to v1.3.7 in the documentation requirements, pulling in upstream fixes (d2 compatibility), a full test framework, packaging migration, and new plugin hooks.

File-Level Changes

Change Details Files
Bump mkdocs-macros-plugin version
  • Replaced version specifier 1.0.5 with 1.3.7 in requirements-docs.txt
requirements-docs.txt

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

codecov bot commented Jul 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.03%. Comparing base (efab6d3) to head (9eaa469).
Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1229      +/-   ##
==========================================
- Coverage   66.73%   62.03%   -4.70%     
==========================================
  Files          68       68              
  Lines       11527    11527              
==========================================
- Hits         7692     7151     -541     
- Misses       3835     4376     +541     
Flag Coverage Δ
unittests 62.03% <ø> (-4.70%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 9 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Author

dependabot bot commented on behalf of github Jul 8, 2025

Looks like mkdocs-macros-plugin is up-to-date now, so this is no longer needed.

@dependabot dependabot bot closed this Jul 8, 2025
@dependabot dependabot bot deleted the dependabot/pip/mkdocs-macros-plugin-1.3.7 branch July 8, 2025 05:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants