materialsproject / workshop

The Materials Project Workshop Curriculum
https://workshop.materialsproject.org
BSD 3-Clause "New" or "Revised" License
112 stars 127 forks source link

Bump mkdocs from 1.2.2 to 1.4.1 #235

Closed dependabot[bot] closed 1 year ago

dependabot[bot] commented 2 years ago

Bumps mkdocs from 1.2.2 to 1.4.1.

Release notes

Sourced from mkdocs's releases.

1.4.1

  • Support theme-namespaced plugin loading (#2998)

    Plugins' entry points can be named as 'sometheme/someplugin'. That will have the following outcome:

    • If the current theme is 'sometheme', the plugin 'sometheme/someplugin' will always be preferred over 'someplugin'.
    • If the current theme isn't 'sometheme', the only way to use this plugin is by specifying plugins: [sometheme/someplugin].

    One can also specify plugins: ['/someplugin'] instead of plugins: ['someplugin'] to definitely avoid the theme-namespaced plugin.

  • Bugfix: mkdocs serve will work correctly with non-ASCII paths and redirects (#3001)

  • Windows: 'colorama' is now a dependency of MkDocs, to ensure colorful log output (#2987)

  • Plugin-related config options have more reliable validation and error reporting (#2997)

  • Translation sub-commands of setup.py were completely dropped. See documentation [1] [2] for their new replacements (#2990)

  • The 'mkdocs' package (wheel and source) is now produced by Hatch build system and pyproject.toml instead of setup.py (#2988)

Other small improvements; see commit log.

1.4.0

Feature upgrades

Hooks (#2978)

The new hooks: config allows you to add plugin-like event handlers from local Python files, without needing to set up and install an actual plugin.

See documentation.

edit_uri flexibility (#2927)

There is a new edit_uri_template: config.
It works like edit_uri but more generally covers ways to construct an edit URL.
See documentation.

Additionally, the edit_uri functionality will now fully work even if repo_url is omitted (#2928)

Upgrades for plugin developers

Note: this release has big changes to the implementation of plugins and their configs. But, the intention is to have zero breaking changes in all reasonably common use cases. Or at the very least if a code fix is required, there should always be a way to stay compatible with older MkDocs versions. Please report if this release breaks something.

Customize event order for plugin event handlers (#2973)

Plugins can now choose to set a priority value for their event handlers. This can override the old behavior where for each event type, the handlers are called in the order that their plugins appear in the plugins config.

If this is set, events with higher priority are called first. Events without a chosen priority get a default of 0. Events that have the same priority are ordered as they appear in the config.

... (truncated)

Commits
  • aa9eabe Release 1.4.1 (#3004)
  • 79fa445 URL-encode paths when serving a redirect (#3001)
  • 64c42a6 Fix tests for previous commit
  • 6b7d0a5 Prevent a confusing stack trace when theme config fails validation
  • 6fca6b5 Support theme-namespaced plugin loading (#2998)
  • 568e63e Merge pull request #2997 from mkdocs/plugconf
  • aaf819f Better guard an edge case in plugin config
  • b964e05 Refactor load_plugin usage
  • 9ada9bf Also tighten warnings of plugin configs
  • 6b4d20e Refactor plugin_cache usage to avoid nested exception
  • 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 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)
dependabot[bot] commented 1 year ago

Superseded by #241.