Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump the docs group with 3 updates #96

Merged
merged 1 commit into from May 1, 2024
Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github May 1, 2024

Bumps the docs group with 3 updates: mkdocs, mkdocstrings and mkdocs-material.

Updates mkdocs from 1.5.3 to 1.6.0

Release notes

Sourced from mkdocs's releases.

1.6.0

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

... (truncated)

Commits

Updates mkdocstrings from 0.24.1 to 0.25.0

Release notes

Sourced from mkdocstrings's releases.

0.25.0

0.25.0 - 2024-04-27

Compare with 0.24.3

Features

  • Support once parameter in logging methods, allowing to log a message only once with a given logger (1532b59 by Timothée Mazzucotelli).
  • Support blank line between ::: path and YAML options (d799d2f by Timothée Mazzucotelli). Issue-450

Code Refactoring

  • Allow specifying name of template loggers (c5b5f69 by Timothée Mazzucotelli).

0.24.3

0.24.3 - 2024-04-05

Compare with 0.24.2

Bug Fixes

  • Support HTML toc labels with Python-Markdown 3.6+ (uncomment code...) (7fe3e5f by Timothée Mazzucotelli).

0.24.2

0.24.2 - 2024-04-02

Compare with 0.24.1

Bug Fixes

Changelog

Sourced from mkdocstrings's changelog.

0.25.0 - 2024-04-27

Compare with 0.24.3

Features

  • Support once parameter in logging methods, allowing to log a message only once with a given logger (1532b59 by Timothée Mazzucotelli).
  • Support blank line between ::: path and YAML options (d799d2f by Timothée Mazzucotelli). Issue-450

Code Refactoring

  • Allow specifying name of template loggers (c5b5f69 by Timothée Mazzucotelli).

0.24.3 - 2024-04-05

Compare with 0.24.2

Bug Fixes

  • Support HTML toc labels with Python-Markdown 3.6+ (uncomment code...) (7fe3e5f by Timothée Mazzucotelli).

0.24.2 - 2024-04-02

Compare with 0.24.1

Bug Fixes

Commits
  • 87d8229 chore: Prepare release 0.25.0
  • c5b5f69 refactor: Allow specifying name of template loggers
  • 7ff1681 docs: Enable parameter headings
  • 253d215 docs: Load inventories for MkDocs and Markdown
  • 1532b59 feat: Support once parameter in logging methods, allowing to log a message ...
  • d799d2f feat: Support blank line between ::: path and YAML options
  • 828bd59 chore: Prepare release 0.24.3
  • 7fe3e5f fix: Support HTML toc labels with Python-Markdown 3.6+ (uncomment code...)
  • 7b9827c chore: Prepare release 0.24.2
  • 17bfc87 chore: Use PEP 440 versioning scheme for changelog
  • Additional commits viewable in compare view

Updates mkdocs-material from 9.5.17 to 9.5.20

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.5.20

  • Fixed deprecation warning in privacy plugin (9.5.19 regression)
  • Fixed #7119: Tags plugin emits deprecation warning (9.5.19 regression)
  • Fixed #7118: Social plugin crashes if fonts are disabled (9.5.19 regression)
  • Fixed #7085: Social plugin crashes on Windows when downloading fonts

mkdocs-material-9.5.19

  • Updated MkDocs to 1.6 and limited version to < 2
  • Updated Docker image to latest Alpine Linux
  • Removed setup.py, now that GitHub fully understands pyproject.toml
  • Improved interop of social plugin with third-party MkDocs themes
  • Fixed #7099: Blog reading time not rendered correctly for Japanese
  • Fixed #7097: Improved resilience of tags plugin when no tags are given
  • Fixed #7090: Active tab indicator in nested content tabs rendering bug

mkdocs-material-9.5.18

  • Refactored tooltips implementation to fix positioning issues
  • Fixed #7044: Rendering glitch when hovering contributor avatar in Chrome
  • Fixed #7043: Highlighted lines in code blocks cutoff on mobile
  • Fixed #6910: Incorrect position of tooltip for page status in sidebar
  • Fixed #6760: Incorrect position and overly long tooltip in tables
  • Fixed #6488: Incorrect position and cutoff tooltip in content tabs
Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.5.20 (2024-04-29)

  • Fixed deprecation warning in privacy plugin (9.5.19 regression)
  • Fixed #7119: Tags plugin emits deprecation warning (9.5.19 regression)
  • Fixed #7118: Social plugin crashes if fonts are disabled (9.5.19 regression)
  • Fixed #7085: Social plugin crashes on Windows when downloading fonts

mkdocs-material-9.5.19+insiders-4.53.8 (2024-04-26)

  • Fixed #7052: Preview extension automatically including all pages
  • Fixed #7051: Instant previews mounting on footnote references
  • Fixed #5165: Improved tooltips not mounting in sidebar for typeset plugin

mkdocs-material-9.5.19+insiders-4.53.7 (2024-04-25)

  • Fixed #7060: Incorrect resolution of translation when using static-i18n

mkdocs-material-9.5.19 (2024-04-25)

  • Updated MkDocs to 1.6 and limited version to < 2
  • Updated Docker image to latest Alpine Linux
  • Removed setup.py, now that GitHub fully understands pyproject.toml
  • Improved interop of social plugin with third-party MkDocs themes
  • Fixed #7099: Blog reading time not rendered correctly for Japanese
  • Fixed #7097: Improved resilience of tags plugin when no tags are given
  • Fixed #7090: Active tab indicator in nested content tabs rendering bug

mkdocs-material-9.5.18 (2024-04-16)

  • Refactored tooltips implementation to fix positioning issues
  • Fixed #7044: Rendering glitch when hovering contributor avatar in Chrome
  • Fixed #7043: Highlighted lines in code blocks cutoff on mobile
  • Fixed #6910: Incorrect position of tooltip for page status in sidebar
  • Fixed #6760: Incorrect position and overly long tooltip in tables
  • Fixed #6488: Incorrect position and cutoff tooltip in content tabs

mkdocs-material-9.5.17+insiders-4.53.6 (2024-04-05)

  • Ensure working directory is set for projects when using projects plugin
  • Fixed #6970: Incorrect relative paths in git submodules with projects plugin

mkdocs-material-9.5.17+insiders-4.53.5 (2024-04-02)

  • Fixed social plugin crashing when no colors are specified in palettes

mkdocs-material-9.5.17 (2024-04-02)

  • Updated Serbian translations
  • Fixed #7003: Confusing keyboard interaction for palette toggle
  • Fixed #7001: Blog posts now show time by default (9.5.16 regression)

... (truncated)

Commits

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
  • @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
  • @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
  • @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
  • @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

Bumps the docs group with 3 updates: [mkdocs](https://github.com/mkdocs/mkdocs), [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs` from 1.5.3 to 1.6.0
- [Release notes](https://github.com/mkdocs/mkdocs/releases)
- [Commits](mkdocs/mkdocs@1.5.3...1.6.0)

Updates `mkdocstrings` from 0.24.1 to 0.25.0
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.24.1...0.25.0)

Updates `mkdocs-material` from 9.5.17 to 9.5.20
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.17...9.5.20)

---
updated-dependencies:
- dependency-name: mkdocs
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: docs
- dependency-name: mkdocstrings
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: docs
- dependency-name: mkdocs-material
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: docs
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels May 1, 2024
@insolor insolor merged commit c80e469 into main May 1, 2024
6 checks passed
@dependabot dependabot bot deleted the dependabot/pip/docs-e3a2343e9c branch May 1, 2024 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant