Closed renovate[bot] closed 1 year ago
github-actions[bot]
commented
1 year ago This PR has been automatically marked as stale because it has been open 30 days with no activity. Remove stale label or comment or this PR will be closed in 10 days
github-actions[bot]
commented
1 year ago This PR was automatically closed because of stale in 10 days
renovate[bot]
commented
1 year ago Because you closed this PR without merging, Renovate will ignore this update (==1.4.3). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the ignoreDeps array of your Renovate config.
If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.
This PR contains the following updates:
==1.2.3->==1.4.3Release Notes
mkdocs/mkdocs
### [`v1.4.3`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.4.3) [Compare Source](https://togithub.com/mkdocs/mkdocs/compare/1.4.2...1.4.3) - Bugfix: for the `hooks` feature, modules no longer fail to load if using some advanced Python features like dataclasses ([#3193](https://togithub.com/mkdocs/mkdocs/issues/3193)) - Bugfix: Don't create `None` sitemap entries if the page has no populated URL - affects sites that exclude some files from navigation ([`07a297b`](https://togithub.com/mkdocs/mkdocs/commit/07a297b3b4de4a1b49469b1497ee34039b9f38fa)) - "readthedocs" theme: - Accessibility: add aria labels to Home logo ([#3129](https://togithub.com/mkdocs/mkdocs/issues/3129)) and search inputs ([#3046](https://togithub.com/mkdocs/mkdocs/issues/3046)) - "readthedocs" theme now supports `hljs_style:` config, same as "mkdocs" theme ([#3199](https://togithub.com/mkdocs/mkdocs/issues/3199)) - Translations: - Built-in themes now also support Indonesian language ([#3154](https://togithub.com/mkdocs/mkdocs/issues/3154)) - Fixed `zh_CN` translation ([#3125](https://togithub.com/mkdocs/mkdocs/issues/3125)) - `tr_TR` translation becomes just `tr` - usage should remain unaffected ([#3195](https://togithub.com/mkdocs/mkdocs/issues/3195)) See [commit log](https://togithub.com/mkdocs/mkdocs/compare/1.4.2...1.4.3). ### [`v1.4.2`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.4.2) [Compare Source](https://togithub.com/mkdocs/mkdocs/compare/1.4.1...1.4.2) - Officially support Python 3.11 ([#3020](https://togithub.com/mkdocs/mkdocs/issues/3020)) > **Note**: Simply upgrading to Python 3.11 can cut off 10-15% of your site's build time. - Support multiple instances of the same plugin ([#3027](https://togithub.com/mkdocs/mkdocs/issues/3027)) If a plugin is specified multiple times in the list under the `plugins:` config, that will create 2 (or more) instances of the plugin with their own config each. Previously this case was unforeseen and, as such, bugged. Now even though this works, by default a warning will appear from MkDocs anyway, unless the plugin adds a class variable `supports_multiple_instances = True`. - Bugfix (regression in 1.4.1): Don't error when a plugin puts a plain string into `warnings` ([#3016](https://togithub.com/mkdocs/mkdocs/issues/3016)) - Bugfix: Relative links will always render with a trailing slash ([#3022](https://togithub.com/mkdocs/mkdocs/issues/3022)) Previously under `use_directory_urls`, links *from* a sub-page *to* the main index page rendered as e.g. `` even though in all other cases the links look like ``. This caused unwanted behavior on some combinations of Web browsers and servers. Now this special-case bug was removed. - Built-in "mkdocs" theme now also supports Norwegian language ([#3024](https://togithub.com/mkdocs/mkdocs/issues/3024)) - Plugin-related warnings look more readable ([#3016](https://togithub.com/mkdocs/mkdocs/issues/3016)) See [commit log](https://togithub.com/mkdocs/mkdocs/compare/1.4.1...1.4.2). ### [`v1.4.1`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.4.1) [Compare Source](https://togithub.com/mkdocs/mkdocs/compare/1.4.0...1.4.1) - Support theme-namespaced plugin loading ([#2998](https://togithub.com/mkdocs/mkdocs/issues/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](https://togithub.com/mkdocs/mkdocs/issues/3001)) - Windows: 'colorama' is now a dependency of MkDocs, to ensure colorful log output ([#2987](https://togithub.com/mkdocs/mkdocs/issues/2987)) - Plugin-related config options have more reliable validation and error reporting ([#2997](https://togithub.com/mkdocs/mkdocs/issues/2997)) - Translation sub-commands of `setup.py` were completely dropped. See documentation [\[1\]](https://www.mkdocs.org/about/contributing/#submitting-changes-to-the-builtin-themes) [\[2\]](https://www.mkdocs.org/dev-guide/translations/#updating-the-translation-catalogs) for their new replacements ([#2990](https://togithub.com/mkdocs/mkdocs/issues/2990)) - The ['mkdocs' package](https://pypi.org/project/mkdocs/#files) (wheel and source) is now produced by Hatch build system and pyproject.toml instead of setup.py ([#2988](https://togithub.com/mkdocs/mkdocs/issues/2988)) Other small improvements; see [commit log](https://togithub.com/mkdocs/mkdocs/compare/1.4.0...1.4.1). ### [`v1.4.0`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.4.0) [Compare Source](https://togithub.com/mkdocs/mkdocs/compare/1.3.1...1.4.0) #### Feature upgrades ##### Hooks ([#2978](https://togithub.com/mkdocs/mkdocs/issues/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**](https://www.mkdocs.org/user-guide/configuration/#hooks). ##### `edit_uri` flexibility ([#2927](https://togithub.com/mkdocs/mkdocs/issues/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**](https://www.mkdocs.org/user-guide/configuration/#edit_uri_template). Additionally, the `edit_uri` functionality will now fully work even if `repo_url` is omitted ([#2928](https://togithub.com/mkdocs/mkdocs/issues/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](https://togithub.com/mkdocs/mkdocs/issues/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](https://www.mkdocs.org/user-guide/configuration/#plugins). 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. Recommended priority values: `100` "first", `50` "early", `0` "default", `-50` "late", `-100` "last".\ As different plugins discover more precise relations to each other, the values should be further tweaked. See [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#event-priorities). ##### New events that persist across builds in `mkdocs serve` ([#2972](https://togithub.com/mkdocs/mkdocs/issues/2972)) The new events are `on_startup` and `on_shutdown`. They run at the very beginning and very end of an `mkdocs` invocation.\ `on_startup` also receives information on how `mkdocs` was invoked (e.g. `serve` `--dirtyreload`). See [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#events). ##### Replace `File.src_path` to not deal with backslashes ([#2930](https://togithub.com/mkdocs/mkdocs/issues/2930)) The property `src_path` uses backslashes on Windows, which doesn't make sense as it's a virtual path.\ To not make a breaking change, there's no change to how *this* property is used, but now you should: - Use **`File.src_uri`** instead of `File.src_path` - and **`File.dest_uri`** instead of `File.dest_path`. These consistently use forward slashes, and are now the definitive source that MkDocs itself uses. See [source code](https://togithub.com/mkdocs/mkdocs/blob/1.4.0/mkdocs/structure/files.py#L151). As a related tip: you should also stop using `os.path.*` or `pathlib.Path()` to deal with these paths, and instead use `posixpath.*` or `pathlib.PurePosixPath()` ##### MkDocs is type-annotated, ready for use with [mypy](https://mypy.readthedocs.io/) ([#2941](https://togithub.com/mkdocs/mkdocs/issues/2941), [#2970](https://togithub.com/mkdocs/mkdocs/issues/2970)) ##### Type annotations for event handler methods ([#2931](https://togithub.com/mkdocs/mkdocs/issues/2931)) MkDocs' plugin event methods now have type annotations. You might have been adding annotations to events already, but now they will be validated to match the original. See [source code](https://togithub.com/mkdocs/mkdocs/blob/1.4.0/mkdocs/plugins.py#L165) and [documentation](https://www.mkdocs.org/dev-guide/plugins/#events). One big update is that now you should annotate method parameters more specifically as `config: defaults.MkDocsConfig` instead of `config: base.Config`. This not only makes it clear that it is the [main config of MkDocs itself](https://togithub.com/mkdocs/mkdocs/blob/1.4.0/mkdocs/config/defaults.py), but also provides type-safe access through attributes of the object (see next section). See [source code](https://togithub.com/mkdocs/mkdocs/blob/1.4.0/mkdocs/config/defaults.py) and [documentation](https://www.mkdocs.org/dev-guide/plugins/#on_event_name). ##### Rework ConfigOption schemas as class-based ([#2962](https://togithub.com/mkdocs/mkdocs/issues/2962)) When developing a plugin, the settings that it accepts used to be specified in the `config_scheme` variable on the plugin class.\ This approach is now soft-deprecated, and instead you should specify the config in a sub-class of `base.Config`. Old example: ```python from mkdocs import plugins from mkdocs.config import base, config_options class MyPlugin(plugins.BasePlugin): config_scheme = ( ('foo', config_options.Type(int)), ('bar', config_options.Type(str, default='')), ) def on_page_markdown(self, markdown: str, *, config: base.Config, **kwargs): if self.config['foo'] < 5: if config['site_url'].startswith('http:'): return markdown + self.config['baz'] ``` This code snippet actually has many mistakes but it will pass all type checks and silently run and even succeed in some cases. So, on to the new equivalent example, changed to new-style schema and attribute-based access:\ (Complaints from "mypy" added inline) ```python from mkdocs import plugins from mkdocs.config import base, config_options as c class MyPluginConfig(base.Config): foo = c.Optional(c.Type(int)) bar = c.Type(str, default='') class MyPlugin(plugins.BasePlugin[MyPluginConfig]): def on_page_markdown(self, markdown: str, *, config: base.MkDocsConfig, **kwargs): if self.config.foo < 5: # Error, `foo` might be `None`, need to check first. if config.site_url.startswith('http:'): # Error, MkDocs' `site_url` also might be `None`. return markdown + self.config.baz # Error, no such attribute `baz`! ``` This lets you notice the errors from a static type checker before running the code and fix them as such: ```python class MyPlugin(plugins.BasePlugin[MyPluginConfig]): def on_page_markdown(self, markdown: str, *, config: base.MkDocsConfig, **kwargs): if self.config.foo is not None and self.config.foo < 5: # OK, `int < int` is valid. if (config.site_url or '').startswith('http:'): # OK, `str.startswith(str)` is valid. return markdown + self.config.bar # OK, `str + str` is valid. ``` See [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#config_scheme). Also notice that we had to explicitly mark the config attribute `foo` as `Optional`.\ The new-style config has all attributes marked as required by default, and specifying `required=False` or `required=True` is not allowed! ##### New: `config_options.Optional` ([#2962](https://togithub.com/mkdocs/mkdocs/issues/2962)) Wrapping something into `Optional` is conceptually similar to "I want the default to be `None`" -- and you *have* to express it like that, because writing `default=None` doesn't actually work. Breaking change: the method `BaseConfigOption.is_required()` was removed. Use `.required` instead. ([#2938](https://togithub.com/mkdocs/mkdocs/issues/2938))\ And even the `required` property should be mostly unused now.\ For class-based configs, there's a new definition for whether an option is "required": - It has no default, and - It is not wrapped into `config_options.Optional`. ##### New: `config_options.ListOfItems` ([#2938](https://togithub.com/mkdocs/mkdocs/issues/2938)) Defines a list of items that each must adhere to the same constraint. Kind of like a validated `Type(list)` Examples how to express a list of integers (with `from mkdocs.config import config_options as c`): Description | Code entry \----------- | ---------- Required to specify | `foo = c.ListOfItems(c.Type(int))` Optional, default is \[] | `foo = c.ListOfItems(c.Type(int), default=[])` Optional, default is None | `foo = c.Optional(c.ListOfItems(c.Type(int)))` See more [examples in **documentation**](https://www.mkdocs.org/dev-guide/plugins/#examples-of-config-definitions). ##### Updated: `config_options.SubConfig` ([#2807](https://togithub.com/mkdocs/mkdocs/issues/2807)) `SubConfig` used to silently ignore all validation of its config options. Now you should pass `validate=True` to it or just use new class-based configs where this became the default. So, it can be used to validate a nested sub-dict with all keys pre-defined and value types strictly validated. See [examples in **documentation**](https://www.mkdocs.org/dev-guide/plugins/#examples-of-config-definitions). ##### Other changes to config options `URL`'s default is now `None` instead of `''`. This can still be checked for truthiness in the same way - `if config.some_url:` ([#2962](https://togithub.com/mkdocs/mkdocs/issues/2962)) `FilesystemObject` is no longer abstract and can be used directly, standing for "file or directory" with optional existence checking ([#2938](https://togithub.com/mkdocs/mkdocs/issues/2938)) Bug fixes: - Fix `SubConfig`, `ConfigItems`, `MarkdownExtensions` to not leak values across different instances ([#2916](https://togithub.com/mkdocs/mkdocs/issues/2916), [#2290](https://togithub.com/mkdocs/mkdocs/issues/2290)) - `SubConfig` raises the correct kind of validation error without a stack trace ([#2938](https://togithub.com/mkdocs/mkdocs/issues/2938)) - Fix dot-separated redirect in `config_options.Deprecated(moved_to)` ([#2963](https://togithub.com/mkdocs/mkdocs/issues/2963)) Tweaked logic for handling `ConfigOption.default` ([#2938](https://togithub.com/mkdocs/mkdocs/issues/2938)) Deprecated config option classes: `ConfigItems` ([#2983](https://togithub.com/mkdocs/mkdocs/issues/2983)), `OptionallyRequired` ([#2962](https://togithub.com/mkdocs/mkdocs/issues/2962)), `RepoURL` ([#2927](https://togithub.com/mkdocs/mkdocs/issues/2927)) #### Theme updates - Styles of admonitions in "MkDocs" theme ([#2981](https://togithub.com/mkdocs/mkdocs/issues/2981)): - Update colors to increase contrast - Apply admonition styles also to `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.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.