chore(deps): update minor and patch updates

Open renovate[bot] opened this issue 1 year ago • 0 comments

This PR contains the following updates:

Package	Change	Type	Update
Babel (source)	`==2.14.0` -> `==2.15.0`		minor
JamesIves/github-pages-deploy-action	`v4.5.0` -> `v4.6.0`	action	minor
Jinja2 (changelog)	`==3.1.3` -> `==3.1.4`		patch
Markdown (changelog)	`==3.5.2` -> `==3.6`		minor
Pygments (changelog)	`==2.17.2` -> `==2.18.0`		minor
griffe (changelog)	`==0.41.0` -> `==0.45.0`		minor
idna (changelog)	`==3.6` -> `==3.7`		minor
mkdocs (changelog)	`==1.5.3` -> `==1.6.0`		minor
mkdocs-autorefs (changelog)	`==1.0.0` -> `==1.0.1`		patch
mkdocs-material (changelog)	`==9.5.11` -> `==9.5.23`		patch
mkdocstrings (changelog)	`==0.24.1` -> `==0.25.1`		minor
mkdocstrings-python (changelog)	`==1.8.0` -> `==1.10.2`		minor
networkx	`==3.2.1` -> `==3.3`		minor
platformdirs	`==4.2.0` -> `==4.2.2`		patch
pymdown-extensions	`==10.7` -> `==10.8.1`		minor
python-adjudicator	`==0.3.2` -> `==0.5.0`		minor
python-dateutil	`==2.8.2` -> `==2.9.0.post0`		minor
regex	`==2024.4.28` -> `==2024.5.15`		minor
typing_extensions (changelog)	`==4.10.0` -> `==4.11.0`		minor

Release Notes

python-babel/babel (Babel)

`v2.15.0`

Compare Source

Python version support


* Babel 2.15.0 will require Python 3.8 or newer. (:gh:`1048`)

Features
~~~~~~~~

* CLDR: Upgrade to CLDR 44 (:gh:`1071`) (@&#8203;akx)
* Dates: Support for the "fall back to short format" logic for time delta formatting (:gh:`1075`) (@&#8203;akx)
* Message: More versatile .po IO functions (:gh:`1068`) (@&#8203;akx)
* Numbers: Improved support for alternate spaces when parsing numbers (:gh:`1007`) (@&#8203;ronnix's first contribution)

Infrastructure
~~~~~~~~~~~~~~

* Upgrade GitHub Actions (:gh:`1054`) (@&#8203;cclauss's first contribution)
* The Unicode license is now included in `locale-data` and in the documentation (:gh:`1074`) (@&#8203;akx)

JamesIves/github-pages-deploy-action (JamesIves/github-pages-deploy-action)

Full Changelog: https://github.com/JamesIves/github-pages-deploy-action/compare/v4.5.0...v4.6.0

pallets/jinja (Jinja2)

`v3.1.4`

Compare Source

Released 2024-05-05

The xmlattr filter does not allow keys with / solidus, > greater-than sign, or = equals sign, in addition to disallowing spaces. Regardless of any validation done by Jinja, user input should never be used as keys to this filter, or must be separately validated first. :ghsa:h75v-3vvj-5mfj

Python-Markdown/markdown (Markdown)

`v3.6`

Compare Source

Changed

Refactor TOC Sanitation

All postprocessors are now run on heading content.
Footnote references are now stripped from heading content. Fixes #660.
A more robust striptags is provided to convert headings to plain text. Unlike, the markupsafe implementation, HTML entities are not unescaped.
The plain text name, rich html, and unescaped raw data-toc-label are saved to toc_tokens, allowing users to access the full rich text content of the headings directly from toc_tokens.
The value of data-toc-label is sanitized separate from heading content before being written to name. This fixes a bug which allowed markup through in certain circumstances. To access the raw unsanitized data, retrieve the value from token['data-toc-label'] directly.
An html.unescape call is made just prior to calling slugify so that slugify only operates on Unicode characters. Note that html.unescape is not run on name, html, or data-toc-label.
The functions get_name and stashedHTML2text defined in the toc extension are both deprecated. Instead, third party extensions should use some combination of the new functions run_postprocessors, render_inner_html and striptags.

Fixed

Include scripts/*.py in the generated source tarballs (#1430).
Ensure lines after heading in loose list are properly detabbed (#1443).
Give smarty tree processor higher priority than toc (#1440).
Permit carets (^) and square brackets (]) but explicitly exclude backslashes (\) from abbreviations (#1444).
In attribute lists (attr_list, fenced_code), quoted attribute values are now allowed to contain curly braces (}) (#1414).

pygments/pygments (Pygments)

`v2.18.0`

Compare Source

(released May 4th, 2024)

New lexers:
- Janet (#2557)
- Lean 4 (#2618, #2626)
- Luau (#2605)
- Mojo (#2691, #2515)
- org-mode (#2628, #2636)
- Promela (#2620)
- Soong / Android.bp (#2659)
- Tact (#2571)
- Typst (#2596)
Updated lexers:
- Awk: recognize ternary operator (#2687)
- Bash: add openrc alias (#2599, #2371)
- Coq: add keywords, lex more vernacular command arguments, produce fewer tokens on heading comments (#2678)
- DNS zone files: Fix comment parsing (#2595)
- Hy: Support unicode literals (#1126)
- Inform6: Update to Inform 6.42 (#2644)
- lean: Fix name handling (#2614)
- Logtalk: add uninstantiation keyword and recognize escape sequences (#2619)
- Macaulay2: Update to 1.23 (#2655)
- Python: fix highlighting of soft keywords before None/True/False
- reStructuredText: use Token.Comment for comments instead of Comment.Preproc (#2598)
- Rust: highlight :, :: and -> as Punctuation and whitespace as Whitespace, instead of Text in both cases (#2631)
- Spice: Add keywords (#2621)
- SQL Explain: allow negative numbers (#2610)
- Swift: Support multiline strings (#2681)
- ThingsDB: add constants and new functions; support template strings (#2624)
- UL4: support nested <?doc?> and <?note?> tags (#2597)
- VHDL: support multi-line comments of VHDL-2008 (#2622)
- Wikitext: Remove kk-* in variant_langs (#2647)
- Xtend: Add val and var (#2602)
New styles:
- Coffee (#2609)
Make background colors in the image formatter work with Pillow 10.0 (#2623)
Require Python 3.8. As a result, the importlib-metadata package is no longer needed for fast plugin discovery on Python 3.7. The plugins extra (used as, e.g., pip install pygments[plugins]) is kept for backwards compatibility but now has no effect. (#2601)
Require the url attribute for lexers inside Pygments, add it to many lexers (#2588)
Replace Pyflakes linter with Ruff (#2592)
Add macOS CI (#2594)
Built-in lexers now declare the version of Pygments in which they were added in a required version_added lexer attribute, instead of a .. versionadded:: directive in the docstring (#2589, #2634)
The url attribute is now required for built-in lexers and has been added to all existing lexers (#2588)
The RTF formatter supports line number and line highlighting now (#1217, #2654)
Add \sa0 keyword in the RTF formatter (#1111, #2607)
Register pycon as an alias for the Python console lexer (#2697)
Add MIME-Type for DesktopLexer (#2613)
Fix native style to meet WCAG AA guidelines (#2600)
Fix typo in documentation (#2672)
Use format strings consistently (#2661)
Add __class_getitem__ to Formatter to improve typing support (#2665)

mkdocstrings/griffe (griffe)

`v0.45.0`

Compare Source

Compare with 0.44.0

Features

Implement -x, --force-inspection CLI option (776063d by Timothée Mazzucotelli).
Implement force_inspection option in the loader API (3266f22 by Timothée Mazzucotelli).
Support inspecting packages (__init__ modules) (3f74f67 by Timothée Mazzucotelli).
Add parameters for resolving aliases to load functions (e418dee by Timothée Mazzucotelli).
Load private sibling modules by default when resolving aliases (4806189 by Timothée Mazzucotelli).

Bug Fixes

Pass down modules collection when inspecting (bc0f74b by Timothée Mazzucotelli).
Catch loading errors when loading additional modules during wildcard expansion and alias resolution (964e0d2 by Timothée Mazzucotelli).

Code Refactoring

Improve stats code and performance (eeb497f by Timothée Mazzucotelli).
Recurse immediately into non-discoverable submodules (no path on disk) during dynamic analysis (d0b7a1d by Timothée Mazzucotelli).
Simplify the code that checks if an object should be aliased or not during dynamic analysis (fc794c2 by Timothée Mazzucotelli).
Avoid side-effect in inspector by checking early if an object is a cached property (a6bfcfd by Timothée Mazzucotelli).

`v0.44.0`

Compare Source

Compare with 0.43.0

Features

Add resolved property on expression names, returning the corresponding Griffe object (9b5ca45 by Timothée Mazzucotelli).

Bug Fixes

Fix enumeration properties on expression names (6f22256 by Timothée Mazzucotelli).

`v0.43.0`

Compare Source

Compare with 0.42.2

Features

Add properties telling whether an expression name resolves to an enumeration class, instance or value (fdb21d9 by Timothée Mazzucotelli). Issue-mkdocstrings/python#124

`v0.42.2`

Compare Source

Compare with 0.42.1

Bug Fixes

Fix target path of aliases for multipart imports (import a.b.c as x) (ee27ad9 by Timothée Mazzucotelli). Issue-259

`v0.42.1`

Compare Source

Compare with 0.42.0

Bug Fixes

Don't return class variables as parameters of dataclasses (2729c22 by Hassan Kibirige). PR-253
Don't turn items annotated as InitVar into dataclass members (6835ea3 by Hassan Kibirige). PR-252

`v0.42.0`

Compare Source

Compare with 0.41.3

Features

Better support for dataclasses (82a9d57 by Timothée Mazzucotelli). Issue-33, Issue-34, Issue-38, Issue-39, PR-240

Bug Fixes

Don't return properties as parameters of dataclasses (again) (8c48397 by Hassan Kibirige). Issue-232, PR-248
Fix getting return type from parent property when parsing Sphinx docstrings (f314957 by Timothée Mazzucotelli). Issue-125

Code Refactoring

Warn (debug) when a submodule shadows a member with the same name (cdc9e1c by Timothée Mazzucotelli). Issue-124

`v0.41.3`

Compare Source

Compare with 0.41.2

Code Refactoring

Catch index errors when finding top module in case of search path misconfiguration (46c56c7 by Timothée Mazzucotelli). Issue-#246

`v0.41.2`

Compare Source

Compare with 0.41.1

Bug Fixes

Fix discovery of packages in the current working directory (44f9617 by Timothée Mazzucotelli). Discussion-mkdocstrings#654

`v0.41.1`

Compare Source

Compare with 0.41.0

Deprecations

The load_git function moved from griffe.git to griffe.loader. It is still importable from griffe.git, but will emit a deprecation warning.

Code Refactoring

Expose Git utilities, move load_git into the loader module (327cc5b by Timothée Mazzucotelli).

kjd/idna (idna)

`v1.6.0`

Compare Source

Local preview

mkdocs serve no longer locks up the browser when more than 5 tabs are open. This is achieved by closing the polling connection whenever a tab becomes inactive. Background tabs will no longer auto-reload either - that will instead happen as soon the tab is opened again. Context: #3391
New flag serve --open to open the site in a browser.
After the first build is finished, this flag will cause the default OS Web browser to be opened at the home page of the local site.
Context: #3500

Drafts

[!warning] Changed from version 1.5:

The exclude_docs config was split up into two separate concepts.

The exclude_docs config no longer has any special behavior for mkdocs serve - it now always completely excludes the listed documents from the site.

If you wish to use the "drafts" functionality like the exclude_docs key used to do in MkDocs 1.5, please switch to the new config key draft_docs.

See documentation.

Other changes:

Reduce warning levels when a "draft" page has a link to a non-existent file. Context: #3449

Update to deduction of page titles

MkDocs 1.5 had a change in behavior in deducing the page titles from the first heading. Unfortunately this could cause unescaped HTML tags or entities to appear in edge cases.

Now tags are always fully sanitized from the title. Though it still remains the case that Page.title is expected to contain HTML entities and is passed directly to the themes.

Images (notably, emojis in some extensions) get preserved in the title only through their alt attribute's value.

Context: #3564, #3578

Themes

Built-in themes now also support Polish language (#3613)

"readthedocs" theme

Fix: "readthedocs" theme can now correctly handle deeply nested nav configurations (over 2 levels deep), without confusedly expanding all sections and jumping around vertically. (#3464)
Fix: "readthedocs" theme now shows a link to the repository (with a generic logo) even when isn't one of the 3 known hosters. (#3435)
"readthedocs" theme now also has translation for the word "theme" in the footer that mistakenly always remained in English. (#3613, #3625)

"mkdocs" theme

The "mkdocs" theme got a big update to a newer version of Bootstrap, meaning a slight overhaul of styles. Colors (most notably of admonitions) have much better contrast.

The "mkdocs" theme now has support for dark mode - both automatic (based on the OS/browser setting) and with a manual toggle. Both of these options are not enabled by default and need to be configured explicitly.
See color_mode, user_color_mode_toggle in documentation.

[!warning] Possible breaking change:

jQuery is no longer included into the "mkdocs" theme. If you were relying on it in your scripts, you will need to separately add it first (into mkdocs.yml) as an extra script:
extra_javascript:
  - https://code.jquery.com/jquery-3.7.1.min.js
Or even better if the script file is copied and included from your docs dir.

Context: #3493, #3649

Configuration

New "`enabled`" setting for all plugins

You may have seen some plugins take up the convention of having a setting enabled: false (or usually controlled through an environment variable) to make the plugin do nothing.

Now every plugin has this setting. Plugins can still choose to implement this config themselves and decide how it behaves (and unless they drop older versions of MkDocs, they still should for now), but now there's always a fallback for every plugin.

See documentation. Context: #3395

Validation

Validation of hyperlinks between pages

Absolute links

Historically, within Markdown, MkDocs only recognized 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. Whereas absolute links were left unmodified (making them often not work as expected or, more recently, warned against).

If you dislike having to always use relative links, now you can opt into absolute links and have them work correctly.

If you set the setting validation.links.absolute_links to the new value relative_to_docs, all Markdown links starting with / will be understood as being relative to the docs_dir root. The links will then be validated for correctness according to all the other rules that were already working for relative links in prior versions of MkDocs. For the HTML output, these links will still be turned relative so that the site still works reliably.

So, now any document (e.g. "dir1/foo.md") can link to the document "dir2/bar.md" as [link](/dir2/bar.md), in addition to the previously only correct way [link](../dir2/bar.md).

You have to enable the setting, though. The default is still to just skip any processing of such links.

See documentation. Context: #3485

Absolute links within nav

Absolute links within the nav: config were also always skipped. It is now possible to also validate them in the same way with validation.nav.absolute_links. Though it makes a bit less sense because then the syntax is simply redundant with the syntax that comes without the leading slash.

Anchors

There is a new config setting that is recommended to enable warnings for:

validation:
  anchors: warn

Example of a warning that this can produce:

WARNING -  Doc file 'foo/example.md' contains a link '../bar.md#some-heading', but the doc 'foo/bar.md' does not contain an anchor '#some-heading'.

Any of the below methods of declaring an anchor will be detected by MkDocs:


#### Heading producing an anchor
#### Another heading {#custom-anchor-for-heading-using-attr-list}

<a id="raw-anchor"></a>

[](){#markdown-anchor-using-attr-list}

Plugins and extensions that insert anchors, in order to be compatible with this, need to be developed as treeprocessors that insert etree elements as their mode of operation, rather than raw HTML which is undetectable for this purpose.

If you as a user are dealing with falsely reported missing anchors and there's no way to resolve this, you can choose to disable these messages by setting this option to ignore (and they are at INFO level by default anyway).

See documentation. Context: #3463

Other changes:

When the nav config is not specified at all, the not_in_nav setting (originally added in 1.5.0) gains an additional behavior: documents covered by not_in_nav will not be part of the automatically deduced navigation. Context: #3443
Fix: the !relative YAML tag for markdown_extensions (originally added in 1.5.0) - it was broken in many typical use cases.

See documentation. Context: #3466
Config validation now exits on first error, to avoid showing bizarre secondary errors. Context: #3437
MkDocs used to shorten error messages for unexpected errors such as "file not found", but that is no longer the case, the full error message and stack trace will be possible to see (unless the error has a proper handler, of course). Context: #3445

Upgrades for plugin developers

Plugins can add multiple handlers for the same event type, at multiple priorities

See mkdocs.plugins.CombinedEvent in documentation. Context: #3448

Enabling true generated files and expanding the `File` API

See documentation.

There is a new pair of attributes File.content_string that becomes the official API for obtaining the content of a file and is used by MkDocs itself.

This replaces the old approach where one had to manually read the file located at File.abs_src_path, although that is still the primary action that these new attributes do under the hood.
The content of a File can be backed by a string and no longer has to be a real existing file at abs_src_path.

It is possible to set the attribute File.content_string or File.content_bytes and it will take precedence over abs_src_path.

Further, abs_src_path is no longer guaranteed to be present and can be None instead. MkDocs itself still uses physical files in all cases, but eventually plugins will appear that don't populate this attribute.
There is a new constructor File.generated() that should be used by plugins instead of the File() constructor. It is much more convenient because one doesn't need to manually look up the values such as docs_dir and use_directory_urls. Its signature is one of:
```
f = File.generated(config: MkDocsConfig, src_uri: str, content: str | bytes)
f = File.generated(config: MkDocsConfig, src_uri: str, abs_src_path: str)
```
This way, it is now extremely easy to add a virtual file even from a hook:
```
def on_files(files: Files, config: MkDocsConfig):
    files.append(File.generated(config, 'fake/path.md', content="Hello, world!"))
```
For large content it is still best to use physical files, but one no longer needs to manipulate the path by providing a fake unused docs_dir.
There is a new attribute File.generated_by that arose by convention - for generated files it should be set to the name of the plugin (the key in the plugins: collection) that produced this file. This attribute is populated automatically when using the File.generated() constructor.
It is possible to set the edit_uri attribute of a File, for example from a plugin or hook, to make it different from the default (equal to src_uri), and this will be reflected in the edit link of the document. This can be useful because some pages aren't backed by a real file and are instead created dynamically from some other source file or script. So a hook could set the edit_uri to that source file or script accordingly.
The File object now stores its original src_dir, dest_dir, use_directory_urls values as attributes.
Fields of File are computed on demand but cached. Only the three above attributes are primary ones, and partly also dest_uri. This way, it is possible to, for example, overwrite dest_uri of a File, and abs_dest_path will be calculated based on it. However you need to clear the attribute first using del f.abs_dest_path, because the values are cached.
File instances are now hashable (can be used as keys of a dict). Two files can no longer be considered "equal" unless it's the exact same instance of File.

Other changes:

The internal storage of File objects inside a Files object has been reworked, so any plugins that choose to access Files._files will get a deprecation warning.
The order of File objects inside a Files collection is no longer significant when automatically inferring the nav. They get forcibly sorted according to the default alphabetic order.

Context: #3451, #3463

Hooks and debugging

Hook files can now import adjacent *.py files using the import statement. Previously this was possible to achieve only through a sys.path workaround. See the new mention in documentation. Context: #3568
Verbose -v log shows the sequence of plugin events in more detail - shows each invoked plugin one by one, not only the event type. Context: #3444

Deprecations

Python 3.7 is no longer supported, Python 3.12 is officially supported. Context: #3429
The theme config file mkdocs_theme.yml no longer executes YAML tags. Context: #3465
The plugin event on_page_read_source is soft-deprecated because there is always a better alternative to it (see the new File API or just on_page_markdown, depending on the desired interaction).

When multiple plugins/hooks apply this event handler, they trample over each other, so now there is a warning in that case.

See documentation. Context: #3503

API deprecations

It is no longer allowed to set File.page to a type other than Page or a subclass thereof. Context: #3443 - following the deprecation in version 1.5.3 and #3381.
Theme._vars is deprecated - use theme['foo'] instead of theme._vars['foo']
utils: modified_time(), get_html_path(), get_url_path(), is_html_file(), is_template_file() are removed. path_to_url() is deprecated.
LiveReloadServer.watch() no longer accepts a custom callback.

Context: #3429

Misc

The sitemap.xml.gz file is slightly more reproducible and no longer changes on every build, but instead only once per day (upon a date change). Context: #3460

Other small improvements; see commit log.

mkdocstrings/autorefs (mkdocs-autorefs)

`v1.0.1`

Compare Source

Compare with 1.0.0

Bug Fixes

Don't import MkDocsConfig (does not exist on MkDocs 1.3-) (9c15664 by Timothée Mazzucotelli).

<detai

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 if that's undesired.

[ ] If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

Feb 28 '24 08:02 renovate[bot]

chore(deps): update minor and patch updates

Release Notes

What's Changed

New Contributors

Changed

Refactor TOC Sanitation

Fixed

Features

Bug Fixes

Code Refactoring

Features

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

Code Refactoring

Code Refactoring

Bug Fixes

Deprecations

Code Refactoring

Local preview

Drafts

Update to deduction of page titles

Themes

"readthedocs" theme

"mkdocs" theme

Configuration

New "enabled" setting for all plugins

Validation

Validation of hyperlinks between pages

Absolute links

Absolute links within nav

Anchors

Upgrades for plugin developers

Plugins can add multiple handlers for the same event type, at multiple priorities

Enabling true generated files and expanding the File API

Hooks and debugging

Deprecations

API deprecations

Misc

Bug Fixes

Configuration

New "`enabled`" setting for all plugins

Enabling true generated files and expanding the `File` API