Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[](https://renovatebot.com)
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [coverage](https://togithub.com/nedbat/coveragepy) | `==7.2.7` ->
`==7.3.2` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [dirty-equals](https://togithub.com/samuelcolvin/dirty-equals)
([changelog](https://togithub.com/samuelcolvin/dirty-equals/releases)) |
`==0.6.0` -> `==0.7.1.post0` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [mkdocs](https://togithub.com/mkdocs/mkdocs)
([changelog](https://www.mkdocs.org/about/release-notes/)) | `==1.4.3`
-> `==1.5.3` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [mkdocs-material](https://togithub.com/squidfunk/mkdocs-material) |
`==9.1.19` -> `==9.4.14` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [pydantic](https://togithub.com/pydantic/pydantic)
([changelog](https://docs.pydantic.dev/latest/changelog/)) | `==2.3.0`
-> `==2.5.2` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [pyright](https://togithub.com/RobertCraigie/pyright-python) |
`==1.1.317` -> `==1.1.338` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [pytest](https://docs.pytest.org/en/latest/)
([source](https://togithub.com/pytest-dev/pytest),
[changelog](https://docs.pytest.org/en/stable/changelog.html)) |
`==7.4.0` -> `==7.4.3` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [pytest-mock](https://togithub.com/pytest-dev/pytest-mock)
([changelog](https://pytest-mock.readthedocs.io/en/latest/changelog.html))
| `==3.11.1` -> `==3.12.0` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [slotscheck](https://togithub.com/ariebovenberg/slotscheck) |
`==0.16.5` -> `==0.17.1` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
| [wheel](https://togithub.com/pypa/wheel)
([changelog](https://wheel.readthedocs.io/en/stable/news.html)) |
`==0.40.0` -> `==0.42.0` |
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
[](https://docs.renovatebot.com/merge-confidence/)
|
---
### Release Notes
<details>
<summary>nedbat/coveragepy (coverage)</summary>
###
[`v7.3.2`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-732--2023-10-02)
[Compare
Source](https://togithub.com/nedbat/coveragepy/compare/7.3.1...7.3.2)
- The `coverage lcov` command ignored the `[report] exclude_lines` and
`[report] exclude_also` settings (`issue 1684`*). This is now fixed,
thanks `Jacqueline Lee <pull 1685_>`*.
- Sometimes SQLite will create journal files alongside the coverage.py
database
files. These are ephemeral, but could be mistakenly included when
combining
data files. Now they are always ignored, fixing `issue 1605`\_. Thanks
to
Brad Smith for suggesting fixes and providing detailed debugging.
- On Python 3.12+, we now disable SQLite writing journal files, which
should be
a little faster.
- The new 3.12 soft keyword `type` is properly bolded in HTML reports.
- Removed the "fullcoverage" feature used by CPython to measure the
coverage of
early-imported standard library modules. CPython `stopped using it
<88054_>`\_ in 2021, and it stopped working completely in Python 3.13.
.. \_issue
1605:[https://github.com/nedbat/coveragepy/issues/1605](https://togithub.com/nedbat/coveragepy/issues/1605)5
.. \_issue
1684[https://github.com/nedbat/coveragepy/issues/1684](https://togithub.com/nedbat/coveragepy/issues/1684)84
.. \_pull
168[https://github.com/nedbat/coveragepy/pull/1685](https://togithub.com/nedbat/coveragepy/pull/1685)685
..
\_880[https://github.com/python/cpython/issues/88054](https://togithub.com/python/cpython/issues/88054)8054
.. \_changes\_7-3-1:
###
[`v7.3.1`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-731--2023-09-06)
[Compare
Source](https://togithub.com/nedbat/coveragepy/compare/7.3.0...7.3.1)
- The semantics of stars in file patterns has been clarified in the
docs. A
leading or trailing star matches any number of path components, like a
double
star would. This is different than the behavior of a star in the middle
of a
pattern. This discrepancy was `identified by Sviatoslav Sydorenko
<starbad_>`*, who `provided patient detailed diagnosis <pull 1650_>`*
and
graciously agreed to a pragmatic resolution.
- The API docs were missing from the last version. They are now
`restored <apidocs_>`\_.
.. \_apidocs:
https://coverage.readthedocs.io/en/latest/api_coverage.html
..
\_starbad[https://github.com/nedbat/coveragepy/issues/1407#issuecomment-1631085209](https://togithub.com/nedbat/coveragepy/issues/1407#issuecomment-1631085209)09
.. \_pull
165[https://github.com/nedbat/coveragepy/pull/1650](https://togithub.com/nedbat/coveragepy/pull/1650)650
.. \_changes\_7-3-0:
###
[`v7.3.0`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-730--2023-08-12)
[Compare
Source](https://togithub.com/nedbat/coveragepy/compare/7.2.7...7.3.0)
- Added a :meth:`.Coverage.collect` context manager to start and stop
coverage
data collection.
- Dropped support for Python 3.7.
- Fix: in unusual circumstances, SQLite cannot be set to asynchronous
mode.
Coverage.py would fail with the error `Safety level may not be changed
inside a transaction.` This is now avoided, closing `issue 1646`\_.
Thanks
to Michael Bell for the detailed bug report.
- Docs: examples of configuration files now include separate examples
for the
different syntaxes: .coveragerc, pyproject.toml, setup.cfg, and tox.ini.
- Fix: added `nosemgrep` comments to our JavaScript code so that
semgrep-based SAST security checks won't raise false alarms about
security
problems that aren't problems.
- Added a CITATION.cff file, thanks to `Ken Schackart <pull 1641_>`\_.
.. \_pull
1641:[https://github.com/nedbat/coveragepy/pull/1641](https://togithub.com/nedbat/coveragepy/pull/1641)1
.. \_issue
1646[https://github.com/nedbat/coveragepy/issues/1646](https://togithub.com/nedbat/coveragepy/issues/1646)46
.. \_changes\_7-2-7:
</details>
<details>
<summary>samuelcolvin/dirty-equals (dirty-equals)</summary>
###
[`v0.7.1.post0`](https://togithub.com/samuelcolvin/dirty-equals/compare/v0.7.1...v0.7.1-post0)
[Compare
Source](https://togithub.com/samuelcolvin/dirty-equals/compare/v0.7.1...v0.7.1-post0)
###
[`v0.7.1`](https://togithub.com/samuelcolvin/dirty-equals/releases/tag/v0.7.1):
2023-11-14
[Compare
Source](https://togithub.com/samuelcolvin/dirty-equals/compare/v0.6.0...v0.7.1)
#### What's Changed
- Docs typo by [@​FBruzzesi](https://togithub.com/FBruzzesi) in
[https://github.com/samuelcolvin/dirty-equals/pull/78](https://togithub.com/samuelcolvin/dirty-equals/pull/78)
- Feature: IsEnum by [@​FBruzzesi](https://togithub.com/FBruzzesi)
in
[https://github.com/samuelcolvin/dirty-equals/pull/75](https://togithub.com/samuelcolvin/dirty-equals/pull/75)
- fix pydantic version checking by
[@​mishaga](https://togithub.com/mishaga) in
[https://github.com/samuelcolvin/dirty-equals/pull/80](https://togithub.com/samuelcolvin/dirty-equals/pull/80)
- change license to exact by
[@​evstratbg](https://togithub.com/evstratbg) in
[https://github.com/samuelcolvin/dirty-equals/pull/85](https://togithub.com/samuelcolvin/dirty-equals/pull/85)
- fix DeprecationWarning with datetime.utcnow() by
[@​MeggyCal](https://togithub.com/MeggyCal) in
[https://github.com/samuelcolvin/dirty-equals/pull/86](https://togithub.com/samuelcolvin/dirty-equals/pull/86)
- Make datetime tests pass without requiring UTC system timezone by
[@​alexmojaki](https://togithub.com/alexmojaki) in
[https://github.com/samuelcolvin/dirty-equals/pull/81](https://togithub.com/samuelcolvin/dirty-equals/pull/81)
- uprev dependencies and use pydantic v2 by
[@​samuelcolvin](https://togithub.com/samuelcolvin) in
[https://github.com/samuelcolvin/dirty-equals/pull/88](https://togithub.com/samuelcolvin/dirty-equals/pull/88)
- support python 3.12 by
[@​samuelcolvin](https://togithub.com/samuelcolvin) in
[https://github.com/samuelcolvin/dirty-equals/pull/89](https://togithub.com/samuelcolvin/dirty-equals/pull/89)
- better dep constraints by
[@​samuelcolvin](https://togithub.com/samuelcolvin) in
[https://github.com/samuelcolvin/dirty-equals/pull/90](https://togithub.com/samuelcolvin/dirty-equals/pull/90)
- fix coverage after dropping 3.7 by
[@​samuelcolvin](https://togithub.com/samuelcolvin) in
[https://github.com/samuelcolvin/dirty-equals/pull/91](https://togithub.com/samuelcolvin/dirty-equals/pull/91)
#### New Contributors
- [@​evstratbg](https://togithub.com/evstratbg) made their first
contribution in
[https://github.com/samuelcolvin/dirty-equals/pull/85](https://togithub.com/samuelcolvin/dirty-equals/pull/85)
- [@​MeggyCal](https://togithub.com/MeggyCal) made their first
contribution in
[https://github.com/samuelcolvin/dirty-equals/pull/86](https://togithub.com/samuelcolvin/dirty-equals/pull/86)
- [@​alexmojaki](https://togithub.com/alexmojaki) made their first
contribution in
[https://github.com/samuelcolvin/dirty-equals/pull/81](https://togithub.com/samuelcolvin/dirty-equals/pull/81)
**Full Changelog**:
https://github.com/samuelcolvin/dirty-equals/compare/v0.7.0...v0.7.1
</details>
<details>
<summary>mkdocs/mkdocs (mkdocs)</summary>
### [`v1.5.3`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.5.3)
[Compare
Source](https://togithub.com/mkdocs/mkdocs/compare/1.5.2...1.5.3)
- Fix `mkdocs serve` sometimes locking up all browser tabs when
navigating quickly
([#​3390](https://togithub.com/mkdocs/mkdocs/issues/3390))
- Add many new supported languages for "search" plugin - update
lunr-languages to 1.12.0
([#​3334](https://togithub.com/mkdocs/mkdocs/issues/3334))
- Bugfix (regression in 1.5.0): In "readthedocs" theme the styling of
"breadcrumb navigation" was broken for nested pages
([#​3383](https://togithub.com/mkdocs/mkdocs/issues/3383))
- Built-in themes now also support Chinese (Traditional, Taiwan)
language
([#​3370](https://togithub.com/mkdocs/mkdocs/issues/3370))
- Plugins can now set `File.page` to their own subclass of `Page`. There
is also now a warning if `File.page` is set to anything other than a
strict subclass of `Page`.
([#​3367](https://togithub.com/mkdocs/mkdocs/issues/3367),
[#​3381](https://togithub.com/mkdocs/mkdocs/issues/3381))
Note that just instantiating a `Page` [sets the file
automatically](https://togithub.com/mkdocs/mkdocs/blob/f94ab3f62d0416d484d81a0c695c8ca86ab3b975/mkdocs/structure/pages.py#L34),
so care needs to be taken not to create an unneeded `Page`.
Other small improvements; see [commit
log](https://togithub.com/mkdocs/mkdocs/compare/1.5.2...1.5.3).
### [`v1.5.2`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.5.2)
[Compare
Source](https://togithub.com/mkdocs/mkdocs/compare/1.5.1...1.5.2)
- Bugfix (regression in 1.5.0): Restore functionality of
`--no-livereload`.
([#​3320](https://togithub.com/mkdocs/mkdocs/issues/3320))
- Bugfix (regression in 1.5.0): The new page title detection would
sometimes be unable to drop anchorlinks - fix that.
([#​3325](https://togithub.com/mkdocs/mkdocs/issues/3325))
- Partly bring back pre-1.5 API: `extra_javascript` items will once
again be mostly strings, and only sometimes `ExtraStringValue` (when the
extra `script` functionality is used).
Plugins should be free to append strings to `config.extra_javascript`,
but when reading the values, they must still make sure to read it as
`str(value)` in case it is an `ExtraScriptValue` item. For querying the
attributes such as `.type` you need to check `isinstance` first. Static
type checking will guide you in that.
([#​3324](https://togithub.com/mkdocs/mkdocs/issues/3324))
See [commit
log](https://togithub.com/mkdocs/mkdocs/compare/1.5.1...1.5.2).
### [`v1.5.1`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.5.1)
[Compare
Source](https://togithub.com/mkdocs/mkdocs/compare/1.5.0...1.5.1)
- Bugfix (regression in 1.5.0): Make it possible to treat
`ExtraScriptValue` as a path. This lets some plugins still work despite
the breaking change.
- Bugfix (regression in 1.5.0): Prevent errors for special setups that
have 3 conflicting files, such as `index.html`, `index.md` *and*
`README.md`
([#​3314](https://togithub.com/mkdocs/mkdocs/issues/3314))
See [commit
log](https://togithub.com/mkdocs/mkdocs/compare/1.5.0...1.5.1).
### [`v1.5.0`](https://togithub.com/mkdocs/mkdocs/releases/tag/1.5.0)
[Compare
Source](https://togithub.com/mkdocs/mkdocs/compare/1.4.3...1.5.0)
**New: MkDocs now accepts donations.** Please consider supporting the
current maintainer at my new GitHub sponsorship page.
MkDocs has been a totally free project since the beginning and wasn't
accepting funds. MkDocs will remain free of paywalls, but now you can
show your support with donations (one-time and/or recurring).
[**Donate for MkDocs - @​oprypin sponsors
page**](https://togithub.com/sponsors/oprypin)
And please also consider these other individuals who have been
contributing to the ecosystem for a long time and check out their
donations pages:
[@​facelessuser](https://togithub.com/sponsors/facelessuser)
[@​pawamoy](https://togithub.com/sponsors/pawamoy)
[@​Ultrabug](https://togithub.com/sponsors/Ultrabug)
***
##### Release 1.5.0
##### New command `mkdocs get-deps`
This command guesses the Python dependencies that a MkDocs site requires
in order to build. It simply prints the PyPI packages that need to be
installed. In the terminal it can be combined directly with an
installation command as follows:
```bash
pip install $(mkdocs get-deps)
```
The idea is that right after running this command, you can directly
follow it up with `mkdocs build` and it will almost always "just work",
without needing to think which dependencies to install.
The way it works is by scanning `mkdocs.yml` for `themes:`, `plugins:`,
`markdown_extensions:` items and doing a reverse lookup based on a large
list of known projects (catalog, see below).
Of course, you're welcome to use a "virtualenv" with such a command.
Also note that for environments that require stability (for example CI)
directly installing deps in this way is not a very reliable approach as
it precludes dependency pinning.
The command allows overriding which config file is used (instead of
`mkdocs.yml` in the current directory) as well as which catalog of
projects is used (instead of downloading it from the default location).
See [`mkdocs get-deps
--help`](https://www.mkdocs.org/user-guide/cli/#mkdocs-get-deps).
Context: [#​3205](https://togithub.com/mkdocs/mkdocs/issues/3205)
##### MkDocs has an official catalog of plugins
Check out <https://github.com/mkdocs/catalog> and add all your
general-purpose plugins, themes and extensions there, so that they can
be looked up through `mkdocs get-deps`.
This was renamed from "best-of-mkdocs" and received significant updates.
In addition to `pip` installation commands, the page now shows the
config boilerplate needed to add a plugin.
##### Expanded validation of links
##### Validated links in Markdown
> As you may know, within Markdown, MkDocs really only recognizes
**relative** links that lead to another physical `*.md` document (or
media file). This is a good convention to follow because then the source
pages are also freely browsable without MkDocs, for example on GitHub.
MkDocs knows that in the output it should turn those `*.md` links into
`*.html` as appropriate, and it would also always tell you if such a
link doesn't actually lead to an existing file.
However, the checks for links were really loose and had many
concessions. For example, links that started with `/` ("absolute") and
links that *ended* with `/` were left as is and no warning was shown,
which allowed such very fragile links to sneak into site sources: links
that happen to work right now but get no validation and links that
confusingly need an extra level of `..` with `use_directory_urls`
enabled.
Now, in addition to validating relative links, MkDocs will print `INFO`
messages for unrecognized types of links (including absolute links).
They look like this:
```text
INFO - Doc file 'example.md' contains an absolute link '/foo/bar/', it was left as is. Did you mean 'foo/bar.md'?
```
If you don't want any changes, not even the `INFO` messages, and wish to
revert to the silence from MkDocs 1.4, add the following configs to
`mkdocs.yml` (**not** recommended):
```yaml
validation:
absolute_links: ignore
unrecognized_links: ignore
```
If, on the opposite end, you want these to print `WARNING` messages and
cause `mkdocs build --strict` to fail, you are recommended to configure
these to `warn` instead.
See
[**documentation**](https://www.mkdocs.org/user-guide/configuration/#validation)
for actual recommended settings and more details. Context:
[#​3283](https://togithub.com/mkdocs/mkdocs/issues/3283)
##### Validated links in the nav
Links to documents in the [`nav`
configuration](https://www.mkdocs.org/user-guide/configuration/#nav) now
also have configurable validation, though with no changes to the
defaults.
You are welcomed to turn on validation for files that were forgotten and
excluded from the nav. Example:
```yaml
validation:
nav:
omitted_files: warn
absolute_links: warn
```
This can make the following message appear with the `WARNING` level (as
opposed to `INFO` as the only option previously), thus being caught by
`mkdocs --strict`:
```text
INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration: ...
```
See
[**documentation**](https://www.mkdocs.org/user-guide/configuration/#validation).
Context: [#​3283](https://togithub.com/mkdocs/mkdocs/issues/3283),
[#​1755](https://togithub.com/mkdocs/mkdocs/issues/1755)
##### Mark docs as intentionally "not in nav"
There is a new config `not_in_nav`. With it, you can mark particular
patterns of files as exempt from the above `omitted_files` warning type;
no messages will be printed for them anymore. (As a corollary, setting
this config to `*` is the same as ignoring `omitted_files` altogether.)
This is useful if you generally like these warnings about files that
were forgotten from the nav, but still have some pages that you
knowingly excluded from the nav and just want to build and copy them.
The `not_in_nav` config is a set of gitignore-like patterns. See the
next section for an explanation of another such config.
See
[**documentation**](https://www.mkdocs.org/user-guide/configuration/#not_in_nav).
Context: [#​3224](https://togithub.com/mkdocs/mkdocs/issues/3224),
[#​1888](https://togithub.com/mkdocs/mkdocs/issues/1888)
##### Excluded doc files
There is a new config `exclude_docs` that tells MkDocs to ignore certain
files under `docs_dir` and *not* copy them to the built `site` as part
of the build.
Historically MkDocs would always ignore file names starting with a dot,
and that's all. Now this is all configurable: you can un-ignore these
and/or ignore more patterns of files.
The `exclude_docs` config follows the [.gitignore pattern
format](https://git-scm.com/docs/gitignore#\_pattern_format) and is
specified as a multiline YAML string. For example:
```yaml
exclude_docs: |
*.py # Excludes e.g. docs/hooks/foo.py
/drafts # Excludes e.g. docs/drafts/hello.md
/requirements.txt # Excludes docs/requirements.txt
```
Validation of links (described above) is also affected by
`exclude_docs`. During `mkdocs serve` the messages explain the
interaction, whereas during `mkdocs build` excluded files are as good as
nonexistent.
As an additional related change, if you have a need to have both
`README.md` and `index.md` files in a directory but publish only one of
them, you can now use this feature to explicitly ignore one of them and
avoid warnings.
See
[**documentation**](https://www.mkdocs.org/user-guide/configuration/#exclude_docs).
Context: [#​3224](https://togithub.com/mkdocs/mkdocs/issues/3224)
##### Drafts
The `exclude_docs` config has another behavior: all excluded Markdown
pages will still be previewable in `mkdocs serve` only, just with a
"DRAFT" marker on top. Then they will of course be excluded from `mkdocs
build` or `gh-deploy`.
If you don't want `mkdocs serve` to have any special behaviors and
instead want it to perform completely normal builds, use the new flag
`mkdocs serve --clean`.
See
[**documentation**](https://www.mkdocs.org/user-guide/configuration/#exclude_docs).
Context: [#​3224](https://togithub.com/mkdocs/mkdocs/issues/3224)
##### `mkdocs serve` no longer exits after build errors
If there was an error (from the config or a plugin) during a site
re-build, `mkdocs serve` used to exit after printing a stack trace. Now
it will simply freeze the server until the author edits the files to fix
the problem, and then will keep reloading.
But errors on the *first* build still cause `mkdocs serve` to exit, as
before.
Context: [#​3255](https://togithub.com/mkdocs/mkdocs/issues/3255)
##### Page titles will be deduced from any style of heading
MkDocs always had the ability to infer the title of a page (if it's not
specified in the `nav`) based on the first line of the document, if it
had a `<h1>` heading that had to written starting with the exact
character `#`. Now any style of Markdown heading is understood
([#​1886](https://togithub.com/mkdocs/mkdocs/issues/1886)). Due to
the previous simplistic parsing, it was also impossible to use
`attr_list` attributes in that first heading
([#​3136](https://togithub.com/mkdocs/mkdocs/issues/3136)). Now
that is also fixed.
##### Markdown extensions can use paths relative to the current document
This is aimed at extensions such as `pymdownx.snippets` or
`markdown_include.include`: you can now specify their include paths to
be relative to the currently rendered Markdown document, or relative to
the `docs_dir`. Any other extension can of course also make use of the
new `!relative` YAML tag.
```yaml
markdown_extensions:
- pymdownx.snippets:
base_path: !relative
```
See
[**documentation**](https://www.mkdocs.org/user-guide/configuration/#paths-relative-to-the-current-file-or-site).
Context: [#​2154](https://togithub.com/mkdocs/mkdocs/issues/2154),
[#​3258](https://togithub.com/mkdocs/mkdocs/issues/3258)
##### `<script>` tags can specify `type="module"` and other attributes
In `extra_javascript`, if you use the `.mjs` file extension or
explicitly specify a `type: module` key, the script will be added with
the `type="module"` attribute. `defer: true` and `async: true` keys are
also available.
See [updated **documentation** for
`extra_javascript`](https://www.mkdocs.org/user-guide/configuration/#extra_javascript).
**At first this is only supported in built-in themes, other themes need
to follow up, see below.**
Context: [#​3237](https://togithub.com/mkdocs/mkdocs/issues/3237)
##### Changes for theme developers (action required!)
Using the construct `{% for script in extra_javascript %}` is now fully
obsolete because it cannot allow customizing the attributes of the
`<script>` tag. It will keep working but blocks some of MkDocs'
features.
Instead, you now need to use `config.extra_javascript` (which was
already the case for a while) and couple it with the new `script_tag`
filter:
```django
{%- for script in config.extra_javascript %}
{{ script | script_tag }}
{%- endfor %}
```
See
[**documentation**](https://www.mkdocs.org/dev-guide/themes/#picking-up-css-and-javascript-from-the-config).
##### Upgrades for plugin developers
- Breaking change: `config.extra_javascript` is no longer a plain list
of strings, but instead a list of `ExtraScriptValue` items. So you can
no longer treat the list values as strings. If you want to keep
compatibility with old versions, just always reference the items as
`str(item)` instead. And you can still append plain strings to the list
if you wish. See information about `<script>` tags above. Context:
[#​3237](https://togithub.com/mkdocs/mkdocs/issues/3237)
- `File` has a new attribute `inclusion`. Its value is calculated from
both the `exclude_docs` and `not_in_nav` configs, and implements their
behavior. Plugins can read this value or write to it. New `File`
instances by default follow whatever the configs say, but plugins can
choose to make this decision explicitly, per file.
- When creating a `File`, one can now set a `dest_uri` directly, rather
than having to update it (and other dependent attributes) after
creation.
[Context](https://togithub.com/mkdocs/mkdocs/commit/d5af6426c52421f1113f6dcc591de1e01bea48bd)
- A new config option was added - `DictOfItems`. Similarly to
`ListOfItems`, it validates a mapping of config options that all have
the same type. Keys are arbitrary but always strings. Context:
[#​3242](https://togithub.com/mkdocs/mkdocs/issues/3242)
- A new function `get_plugin_logger` was added. In order to opt into a
standardized way for plugins to log messages, please use the idiom:
```python
log = mkdocs.plugins.get_plugin_logger(__name__)
...
log.info("Hello, world")
```
Context: [#​3245](https://togithub.com/mkdocs/mkdocs/issues/3245)
- `SubConfig` config option can be conveniently subclassed with a
particular type of config specified. For example, `class
ExtraScript(SubConfig[ExtraScriptValue]):`. To see how this is useful,
search for this class in code.
[Context](https://togithub.com/mkdocs/mkdocs/commit/73e503990e3e3504bfe1cb627d41a7e97970687e)
- Bugfix: `SubConfig` had a bug where paths (from `FilesystemObject`
options) were not made relative to the main config file as intended,
because `config_file_path` was not properly inherited to it. This is now
fixed. Context:
[#​3265](https://togithub.com/mkdocs/mkdocs/issues/3265)
- `Config` members now have a way to avoid clashing with Python's
reserved words. This is achieved by stripping a trailing underscore from
each member's name.
Example of adding an `async` boolean option that can be set by the user
as `async: true` and read programmatically as `config.async_`:
```python
class ExampleConfig(Config):
async_ = Type(bool, default=False)
```
Previously making a config key with a reserved name was impossible with
new-style schemas.
[Context](https://togithub.com/mkdocs/mkdocs/commit/1db8e884fa7135a49adf7740add5d875a16a18bc)
- `Theme` has its attributes properly declared and gained new attributes
`theme.locale`, `theme.custom_dir`.
- Some type annotations were made more precise. For example:
- The `context` parameter has gained the type `TemplateContext`
(`TypedDict`).
[Context](https://togithub.com/mkdocs/mkdocs/commit/0f793b9984c7e6a1d53ce874e7d17b6d27ebf4b2)
- The classes `Page`, `Section`, `Link` now have a common base class
`StructureItem`.
[Context](https://togithub.com/mkdocs/mkdocs/commit/01be507e30b05db0a4c44ef05ba62b2098010653)
- Some methods stopped accepting `Config` and only accept `MkDocsConfig`
as was originally intended.
[Context](https://togithub.com/mkdocs/mkdocs/commit/c459cd24fc0320333f51525e9cf681d4a8370f50)
- `config.mdx_configs` got a proper type. Context:
[#​3229](https://togithub.com/mkdocs/mkdocs/issues/3229)
##### Theme updates
- Built-in themes mostly stopped relying on `<script defer>`. This may
affect some usages of `extra_javascript`, mainly remove the need for
custom handling of "has the page fully loaded yet". Context:
[#​3237](https://togithub.com/mkdocs/mkdocs/issues/3237)
- "mkdocs" theme now has a styling for `>` blockquotes, previously they
were not distinguished at all. Context:
[#​3291](https://togithub.com/mkdocs/mkdocs/issues/3291)
- "readthedocs" theme was updated to v1.2.0 according to upstream, with
improved styles for `<kbd>` and breadcrumb navigation. Context:
[#​3058](https://togithub.com/mkdocs/mkdocs/issues/3058)
- Both built-in themes had their version of highlight.js updated to
11.8.0, and jQuery updated to 3.6.0.
##### Bug fixes
##### Relative paths in the nav can traverse above the root
Regression in 1.2 - relative paths in the nav could no longer traverse
above the site's root and were truncated to the root. Although such
traversal is discouraged and produces a warning, this was a documented
behavior. The behavior is now restored.
Context: [#​2752](https://togithub.com/mkdocs/mkdocs/issues/2752),
[#​3010](https://togithub.com/mkdocs/mkdocs/issues/3010)
##### MkDocs can accept the config from stdin
This can be used for config overrides on the fly. See updated section at
the bottom of [Configuration
Inheritance](https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance).
The command to use this is `mkdocs build -f -`. In previous versions
doing this led to an error.
[Context](https://togithub.com/mkdocs/mkdocs/commit/d5bb15fa108da86a8e53fb7d84109d8f8d9d6453)
##### New command line flags
- `mkdocs --no-color build` disables color output and line wrapping.
This option is also available through an environment variable
`NO_COLOR=true`. Context:
[#​3282](https://togithub.com/mkdocs/mkdocs/issues/3282)
- `mkdocs build --no-strict` overrides the `strict` config to `false`.
Context: [#​3254](https://togithub.com/mkdocs/mkdocs/issues/3254)
- `mkdocs build -f -` (described directly above).
- `mkdocs serve --clean` (described above).
- `mkdocs serve --dirty` is the new name of `mkdocs serve
--dirtyreload`.
##### Deprecations
- `extra_javascript` underwent a change that can break plugins in rare
cases, and it requires attention from theme developers. See respective
entries above.
- Python-Markdown was unpinned from `<3.4`. That version is known to
remove functionality. If you are affected by those removals, you can
still choose to pin the version for yourself: `Markdown <3.4`. Context:
[#​3222](https://togithub.com/mkdocs/mkdocs/issues/3222),
[#​2892](https://togithub.com/mkdocs/mkdocs/issues/2892)
- `mkdocs.utils.warning_filter` now shows a warning about being
deprecated. It does nothing since MkDocs 1.2. Consider
`get_plugin_logger` or just logging under `mkdocs.plugins.*` instead.
Context: [#​3008](https://togithub.com/mkdocs/mkdocs/issues/3008)
- Accessing the `_vars` attribute of a `Theme` is deprecated - just
access the keys directly.
- Accessing the `user_configs` attribute of a `Config` is deprecated.
Note: instead of `config.user_configs[*]['theme']['custom_dir']`, please
use the new attribute `config.theme.custom_dir`.
Other small improvements; see [commit
log](https://togithub.com/mkdocs/mkdocs/compare/1.4.3...1.5.0).
</details>
<details>
<summary>squidfunk/mkdocs-material (mkdocs-material)</summary>
###
[`v9.4.14`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.14):
mkdocs-material-9.4.14
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.13...9.4.14)
- Added support for linking authors in blog posts
###
[`v9.4.13`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.13):
mkdocs-material-9.4.13
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.12...9.4.13)
- Fixed
[#​6365](https://togithub.com/squidfunk/mkdocs-material/issues/6365):
Blog plugin pagination links to previous pages broken
- Fixed
[#​5758](https://togithub.com/squidfunk/mkdocs-material/issues/5758):
Updated Mermaid.js to version 10.6.1 (latest)
###
[`v9.4.12`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.12):
mkdocs-material-9.4.12
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.11...9.4.12)
- Improved blog plugin to generate Unicode-aware slugs by default
- Fixed non-deterministic order of categories in blog plugin
###
[`v9.4.11`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.11):
mkdocs-material-9.4.11
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.10...9.4.11)
- Fixed
[#​6364](https://togithub.com/squidfunk/mkdocs-material/issues/6364):
Search plugin crashing when enabling theme while serving
- Fixed blog plugin crashing when disabling pagination
###
[`v9.4.10`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.10):
mkdocs-material-9.4.10
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.9...9.4.10)
- Fixed
[#​6356](https://togithub.com/squidfunk/mkdocs-material/issues/6356):
Version selector can't be disabled via mike's configuration
- Fixed
[#​6281](https://togithub.com/squidfunk/mkdocs-material/issues/6281):
Navigation not rendering due to Safari bug (9.4.2 regression)
- Fixed
[#​6261](https://togithub.com/squidfunk/mkdocs-material/issues/6261):
Navigation expansion animates on first load (9.4.2 regression)
###
[`v9.4.9`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.9):
mkdocs-material-9.4.9
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.8...9.4.9)
- Fixed
[#​6344](https://togithub.com/squidfunk/mkdocs-material/issues/6344):
Long entries cutoff in table of contents
- Fixed
[#​6336](https://togithub.com/squidfunk/mkdocs-material/issues/6336):
Custom template for glob archive not working with pagination
- Fixed
[#​6328](https://togithub.com/squidfunk/mkdocs-material/issues/6328):
Blog plugin crashes for locales with dashes, e.g. `pt-BR`
- Fixed
[#​6327](https://togithub.com/squidfunk/mkdocs-material/issues/6327):
Copy-to-clipboard button doesn't trim trailing line feed
- Fixed
[#​6302](https://togithub.com/squidfunk/mkdocs-material/issues/6302):
Version strings not matched when using mike, only aliases
- Fixed instant navigation progress indicator for gzipped content in
Chrome
- Fixed rendering bug on details marker rotation in Firefox
###
[`v9.4.8`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.8):
mkdocs-material-9.4.8
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.7...9.4.8)
- Fixed invalid local address replacement when using instant loading
- Fixed
[#​6275](https://togithub.com/squidfunk/mkdocs-material/issues/6275):
Crash after navigation caused 404 when using instant loading
###
[`v9.4.7`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.7):
mkdocs-material-9.4.7
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.6...9.4.7)
- Added Azerbaijani translations
###
[`v9.4.6`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.6):
mkdocs-material-9.4.6
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.5...9.4.6)
- Updated Danish and Norwegian (Nynorsk) translations
- Fixed
[#​6169](https://togithub.com/squidfunk/mkdocs-material/issues/6169):
Blog post metadata layout overflows on small screens
###
[`v9.4.5`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.5):
mkdocs-material-9.4.5
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.4...9.4.5)
- Fixed sidebar auto-positioning (9.4.2 regression)
- Fixed
[#​6166](https://togithub.com/squidfunk/mkdocs-material/issues/6166):
Improve group plugin compatibility with Python < 3.10
- Fixed
[#​6157](https://togithub.com/squidfunk/mkdocs-material/issues/6157):
Hiding tags does not work (9.4.3 regression)
###
[`v9.4.4`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.4):
mkdocs-material-9.4.4
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.3...9.4.4)
- Added support for overriding text to be copied for code blocks
- Fixed broken layout in some browsers at breakpoints when using zoom
- Fixed
[#​6132](https://togithub.com/squidfunk/mkdocs-material/issues/6132):
Incomplete search highlighting for code blocks in titles
###
[`v9.4.3`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.3):
mkdocs-material-9.4.3
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.2...9.4.3)
- Added support for instant navigation progress indicator
- Improved spacing and alignment of tags
- Moved back-to-top button into separate partial
- Fixed
[#​6104](https://togithub.com/squidfunk/mkdocs-material/issues/6104):
Indentation for some code blocks lost in search
- Fixed
[#​6094](https://togithub.com/squidfunk/mkdocs-material/issues/6094):
Blog post metadata overlaps with footer on small screens
- Fixed
[#​6069](https://togithub.com/squidfunk/mkdocs-material/issues/6069):
Blog plugin crashes for categories with non-ASCII names
**Updated templates**
([diff](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.2...9.4.3))
- `base.html`
###
[`v9.4.2`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.2):
mkdocs-material-9.4.2
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.1...9.4.2)
- Updated Slovenian translations
- Added animation to sidebar navigation expansion and collapse
- Added support for auto-replacement of document head for instant
navigation
- Improved compatibility of new emoji extension with Python < 3.10
- Switched regex dependency to use minimal version
- Refactored alignment and spacing of sidebar navigation
- Fixed expansion button not focusable via keyboard in sidebar
navigation
- Fixed viewport offset restoration on first load when using instant
navigation
- Fixed accidental highlight of non-clickable elements in blog plugin
sidebar
- Fixed
[#​6041](https://togithub.com/squidfunk/mkdocs-material/issues/6041):
Blog plugin crashes when `nav` is defined and blog not included
- Fixed
[#​5972](https://togithub.com/squidfunk/mkdocs-material/issues/5972):
Blog plugin ignores section index pages in paginated views
- Fixed
[#​5954](https://togithub.com/squidfunk/mkdocs-material/issues/5954):
Repeated click on anchor ignored when using instant navigation
- Fixed
[#​5742](https://togithub.com/squidfunk/mkdocs-material/issues/5742):
Keyboard navigation broken when using instant navigation
**Updated templates**
([diff](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.1...9.4.2))
- `partials/nav-item.html`
- `blog-post.html`
###
[`v9.4.1`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.1):
mkdocs-material-9.4.1
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.4.0...9.4.1)
- Improved colors and contrast in dark mode
- Improved admonition borders to match font weight
- Switched content tabs to neutral color
###
[`v9.4.0`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.4.0):
mkdocs-material-9.4.0
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.3.2...9.4.0)
- Added Belarusian translations
- Added version info to entrypoint of package
- Added emoji extension as a replacement for `materialx`
- Improved slate color scheme (dark mode) - now even darker
- Restructured project to improve development experience
- Updated MkDocs to 1.5.3
- Fixed
[#​3890](https://togithub.com/squidfunk/mkdocs-material/issues/3890):
Development mode crash on Linux
###
[`v9.3.2`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.3.2):
mkdocs-material-9.3.2
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.3.1...9.3.2)
- Updated Slovenian translations
- Updated Python dependencies in requirements to use minimum versions
- Fixed
[#​6017](https://togithub.com/squidfunk/mkdocs-material/issues/6017):
Code highlighting inconsistent in Community and Insiders edition
- Fixed
[#​6001](https://togithub.com/squidfunk/mkdocs-material/issues/6001):
Contributor avatars display incorrectly in Firefox
- Fixed
[#​6000](https://togithub.com/squidfunk/mkdocs-material/issues/6000):
Blog post drafts are included in navigation
###
[`v9.3.1`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.3.1):
mkdocs-material-9.3.1
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.3.0...9.3.1)
- Fixed crash of group plugin when used together with hooks
###
[`v9.3.0`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.3.0):
mkdocs-material-9.3.0
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.8...9.3.0)
- Improved configuration sharing between community and Insiders edition
- Added experimental built-in group plugin for enabling plugins
conditionally
- Added new settings in tags plugin for enabling/disabling
- Dropped support for Python 3.7 (EOL)
###
[`v9.2.8`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.8):
mkdocs-material-9.2.8
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.7...9.2.8)
- Updated Italian and Russian translations
- Fixed
[#​5952](https://togithub.com/squidfunk/mkdocs-material/issues/5952):
Combining blog and tags plugin leads to wrong links
- Fixed
[#​5951](https://togithub.com/squidfunk/mkdocs-material/issues/5951):
Blog plugin ignores post title in metadata
- Fixed
[#​5949](https://togithub.com/squidfunk/mkdocs-material/issues/5949):
Blog plugin ignores post linked in nav
###
[`v9.2.7`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.7):
mkdocs-material-9.2.7
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.6...9.2.7)
- Switched dependencies to compatible release clauses
- Removed `readtime` and `lxml` dependencies for blog plugin
- Reduced size of Docker image to improve CI build performance
- Fixed
[#​5945](https://togithub.com/squidfunk/mkdocs-material/issues/5945):
Incorrect footer navigation for sibling pages of blog
- Fixed
[#​5939](https://togithub.com/squidfunk/mkdocs-material/issues/5939):
Page jumps when changing color palette (Firefox 117)
- Fixed
[#​5901](https://togithub.com/squidfunk/mkdocs-material/issues/5901):
Announcement bar reappears when using instant loading
- Fixed
[#​5824](https://togithub.com/squidfunk/mkdocs-material/issues/5824):
Allow to customize styles of sequence diagrams
###
[`v9.2.6`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.6):
mkdocs-material-9.2.6
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.5...9.2.6)
- Added Basque translations
- Added template for simple redirects
- Improved blog plugin interop by moving view generation to `on_files`
- Fixed
[#​5924](https://togithub.com/squidfunk/mkdocs-material/issues/5924):
Social plugin still checks dependencies when disabled
- Fixed
[#​5916](https://togithub.com/squidfunk/mkdocs-material/issues/5916):
Blog plugin crashes on Python 3.8 (9.2.0 regression)
###
[`v9.2.5`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.5):
mkdocs-material-9.2.5
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.4...9.2.5)
- Fixed error in dirty serve mode when using blog plugin
- Fixed page title not being consistent in blog plugin pagination
- Fixed
[#​5899](https://togithub.com/squidfunk/mkdocs-material/issues/5899):
Blog plugin pagination breaks when disabling directory URLs
###
[`v9.2.4`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.4):
mkdocs-material-9.2.4
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.3...9.2.4)
- Added version to bug report name in info plugin
- Updated Afrikaans translations
###
[`v9.2.3`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.3):
mkdocs-material-9.2.3
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.2...9.2.3)
- Fixed blog plugin rendering wrongly with `markdown.extensions.toc`
- Fixed blog plugin entrypoint generation
###
[`v9.2.2`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.2):
mkdocs-material-9.2.2
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.1...9.2.2)
- Fixed
[#​5880](https://togithub.com/squidfunk/mkdocs-material/issues/5880):
Blog plugin failing when building a standalone blog
- Fixed
[#​5881](https://togithub.com/squidfunk/mkdocs-material/issues/5881):
Blog plugin not compatible with Python < 3.10
###
[`v9.2.1`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.1):
mkdocs-material-9.2.1
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.2.0...9.2.1)
- Fixed
[#​5879](https://togithub.com/squidfunk/mkdocs-material/issues/5879):
Blog plugin failing when building a standalone blog
- Fixed error in blog plugin when using draft tagging on future date
- Fixed error in blog plugin when toc extension is not enabled
###
[`v9.2.0`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.2.0):
mkdocs-material-9.2.0
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.1.21...9.2.0)
**Additions and improvements**
- Added blogging support via built-in blog plugin
- Added support for Chinese language segmentaiton in search plugin
- Added support for adding custom dates to blog posts
- Added support for paginating archive and category pages
- Added support for annotations (outside of code blocks)
- Added support for navigation icons
- Added support for navigation pruning
- Added support for navigation status
- Added support for customizing site icons
- Added support for customizing (code) annotation icons
- Added focus outline to admonitions and details
- Added prompt for bug report name to info plugin
- Added Luxembourgish translations
- Improved rendering of (code) annotation markers
- Improved print styles for (code) annotations
- Improved customizability of navigation tabs
- Improved interop of plugins with external tools like mike
- Improved interop of blog plugin with awesome pages plugin
- Improved header partial by moving buttons into separate partials
- Improved clarity of `site_url` warning in social plugin
- Improved blog plugin to automatically setup directory structure
- Switched info plugin to `importlib` to mitigate deprecations
- Automatically download ResizeObserver polyfill when necessary
- Automatically add iframe-worker polyfill when necessary in offline
plugin
- Automatically focus and bring up keyboard on touch devices
- Updated Serbo-Croatian translations
- Updated MkDocs to 1.5.2
**Removals**
- Removed Universal Analytics integration
- Removed ancient polyfills to reduce size of bundled JavaScript by 20%
- Removed necessity for `Array.flat` and `Array.flatMap` polyfill
- Removed announcement bar button when JavaScript is not available
**Fixes**
- Fixed rendering of tags when announcement bar is present
- Fixed tags plugin rendering pages excluded by other plugins
- Fixed
[#​5132](https://togithub.com/squidfunk/mkdocs-material/issues/5132):
Blog plugin requires `nav` entry in `mkdocs.yml`
- Fixed
[#​5599](https://togithub.com/squidfunk/mkdocs-material/issues/5599):
Insufficient contrast for default link color
- Fixed
[#​5715](https://togithub.com/squidfunk/mkdocs-material/issues/5715):
Blog plugin missing integrated table of contents in pagination
- Fixed
[#​5806](https://togithub.com/squidfunk/mkdocs-material/issues/5806):
Version selector not hoverable on some Android devices
- Fixed
[#​5826](https://togithub.com/squidfunk/mkdocs-material/issues/5826):
Blog post drafts with tags show up in tags index
###
[`v9.1.21`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.1.21):
mkdocs-material-9.1.21
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.1.20...9.1.21)
- Fixed MkDocs 1.4 compat issue in social plugin (9.1.20 regression)
###
[`v9.1.20`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.1.20):
mkdocs-material-9.1.20
[Compare
Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.1.19...9.1.20)
- Updated Sanskrit translations
- Fixed deprecation warnings for social plugin
</details>
<details>
<summary>pydantic/pydantic (pydantic)</summary>
###
[`v2.5.2`](https://togithub.com/pydantic/pydantic/releases/tag/v2.5.2):
2023-11-22
[Compare
Source](https://togithub.com/pydantic/pydantic/compare/v2.5.1...v2.5.2)
##### v2.5.2 (2023-11-22)
[GitHub
release](https://togithub.com/pydantic/pydantic/releases/tag/v2.5.2)
##### What's Changed
##### Packaging
- uprev `pydantic-core` to 2.14.5
##### New Features
- Add `ConfigDict.ser_json_inf_nan` by
[@​davidhewitt](https://togithub.com/davidhewitt) in
[#​8159](https://togithub.com/pydantic/pydantic/pull/8159)
##### Fixes
- Fix validation of `Literal` from JSON keys when used as `dict` key by
[@​sydney-runkle](https://togithub.com/sydney-runkle) in
[pydantic/pydantic-core#1075](https://togithub.com/pydantic/pydantic-core/pull/1075)
- Fix bug re `custom_init` on members of `Union` by
[@​sydney-runkle](https://togithub.com/sydney-runkle) in
[pydantic/pydantic-core#1076](https://togithub.com/pydantic/pydantic-core/pull/1076)
- Fix `JsonValue` `bool` serialization by
[@​sydney-runkle](https://togithub.com/sydney-runkle) in
[#​8190](https://togithub.com/pydantic/pydantic/pull/8159)
- Fix handling of unhashable inputs with `Literal` in `Union`s by
[@​sydney-runkle](https://togithub.com/sydney-runkle) in
[pydantic/pydantic-core#1089](https://togithub.com/pydantic/pydantic-core/pull/1089)
###
[`v2.5.1`](https://togithub.com/pydantic/pydantic/blob/HEAD/HISTORY.md#v251-2023-11-15)
[Compare
Source](https://togithub.com/pydantic/pydantic/compare/v2.5.0...v2.5.1)
[GitHub
release](https://togithub.com/pydantic/pydantic/releases/tag/v2.5.1)
##### What's Changed
##### Packaging
- uprev pydantic-core to 2.14.3 by
[@​samuelcolvin](https://togithub.com/samuelcolvin) in
[#​8120](https://togithub.com/pydantic/pydantic/pull/8120)
##### Fixes
- Fix package description limit by
[@​dmontagu](https://togithub.com/dmontagu) in
[#​8097](https://togithub.com/pydantic/pydantic/pull/8097)
- Fix `ValidateCallWrapper` error when creating a model which has a
@​validate_call wrapped field annotation by
[@​sydney-runkle](https://togithub.com/sydney-runkle) in
[#​8110](https://togithub.com/pydantic/pydantic/pull/8110)
###
[`v2.5.0`](https://togithub.com/pydantic/pydantic/blob/HEAD/HISTORY.md#v250-2023-11-13)
[Compare
Source](https://togithub.com/pydantic/pydantic/compare/v2.4.2...v2.5.0)
[GitHub
release](https://togithub.com/pydantic/pydantic/releases/tag/v2.5.0)
The code released in v2.5.0 is functionally identical to that of
v2.5.0b1.
##### What's Changed
##### Packaging
- Update pydantic-core from 2.10.1 to 2.14.1, significant changes from
these updates are described below, full changelog
[here](https://togithub.com/pydantic/pydantic-core/compare/v2.10.1...v2.14.1)
- Update to `pyright==1.1.335` by
[@​Viicos](https://togithub.com/Viicos) in
[#​8075](https://togithub.com/pydantic/pydantic/pull/8075)
##### New Features
- Allow plugins to catch non `ValidationError` errors by
[@​adriangb](https://togithub.com/adriangb) in
[#​7806](https://togithub.com/pydantic/pydantic/pull/7806)
- Support `__doc__` argument in `create_model()` by
[@​chris-spann](https://togithub.com/chris-spann) in
[#​7863](https://togithub.com/pydantic/pydantic/pull/7863)
- Expose `regex_engine` flag - meaning you can use with the Rust or
Python regex libraries in constraints by
[@​utkini](https://togithub.com/utkini) in
[#​7768](https://togithub.com/pydantic/pydantic/pull/7768)
- Save return type generated from type annotation in `ComputedFieldInfo`
by [@​alexmojaki](https://togithub.com/alexmojaki) in
[#​7889](https://togithub.com/pydantic/pydantic/pull/7889)
- Adopting `ruff` formatter by
[@​Luca-Blight](https://togithub.com/Luca-Blight) in
[#​7930](https://togithub.com/pydantic/pydantic/pull/7930)
- Added `validation_error_cause` to config by
[@​zakstucke](https://togithub.com/zakstucke) in
[#​7626](https://togithub.com/pydantic/pydantic/pull/7626)
- Make path of the item to validate available in plugin by
[@​hramezani](https://togithub.com/hramezani) in
[#​7861](https://togithub.com/pydantic/pydantic/pull/7861)
- Add `CallableDiscriminator` and `Tag` by
[@​dmontagu](https://togithub.com/dmontagu) in
[#​7983](https://togithub.com/pydantic/pydantic/pull/7983)
- `CallableDiscriminator` renamed to `Discriminator` by
[@​dmontagu](https://togithub.com/dmontagu) in
[#​8047](https://togithub.com/pydantic/pydantic/pull/8047)
- Make union case tags affect union error messages by
[@​dmontagu](https://togithub.com/dmontagu) in
[#​8001](https://togithub.com/pydantic/pydantic/pull/8001)
- Add `examples` and `json_schema_extra` to `@computed_field` by
[@​alexmojaki](https://togithub.com/alexmojaki) in
[#​8013](https://togithub.com/pydantic/pydantic/pull/8013)
- Add `JsonValue` type by [@​dmontagu](https://togithub.
</details>
---
### 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.
👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box
---
This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/RobertCraigie/prisma-client-py).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMS4wIiwidXBkYXRlZEluVmVyIjoiMzcuNTkuOCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
---------
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Robert Craigie <[email protected]>- Loading branch information
1 parent
a465b43
commit 7aaec3b