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 in /docs with 2 updates #599

Merged
merged 1 commit into from
Oct 20, 2023

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 18, 2023

Bumps the docs group in /docs with 2 updates: markdown-include and mkdocs-material.

Updates markdown-include from 0.8.0 to 0.8.1

Release notes

Sourced from markdown-include's releases.

v0.8.1

What's Changed

Full Changelog: cmacmackin/markdown-include@v0.8.0...v0.8.1

Commits
  • 8da79f0 Merge pull request #43 from cmacmackin/fix-inherit-heading-depth
  • 5135d01 Use more explicit str.splitlines()
  • 7ae38cb Fix inheritHeadingDepth adding extra newlines
  • 4e08bb8 Remove sha-bang
  • 0ffd510 Expand gitignore
  • aa4a380 Simplify test resource directory path
  • See full diff in compare view

Updates mkdocs-material from 8.5.11 to 9.4.6

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.4.6

  • Updated Danish and Norwegian (Nynorsk) translations
  • Fixed #6169: Blog post metadata layout overflows on small screens

mkdocs-material-9.4.5

  • Fixed sidebar auto-positioning (9.4.2 regression)
  • Fixed #6166: Improve group plugin compatibility with Python < 3.10
  • Fixed #6157: Hiding tags does not work (9.4.3 regression)

mkdocs-material-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: Incomplete search highlighting for code blocks in titles

mkdocs-material-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: Indentation for some code blocks lost in search
  • Fixed #6094: Blog post metadata overlaps with footer on small screens
  • Fixed #6069: Blog plugin crashes for categories with non-ASCII names

Updated templates (diff)

  • base.html

mkdocs-material-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: Blog plugin crashes when nav is defined and blog not included
  • Fixed #5972: Blog plugin ignores section index pages in paginated views
  • Fixed #5954: Repeated click on anchor ignored when using instant navigation
  • Fixed #5742: Keyboard navigation broken when using instant navigation

Updated templates (diff)

  • partials/nav-item.html
  • blog-post.html

mkdocs-material-9.4.1

  • Improved colors and contrast in dark mode
  • Improved admonition borders to match font weight
  • Switched content tabs to neutral color

... (truncated)

Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.4.6+insiders-4.42.2 (2023-10-14)

  • Fixed #6186: Privacy plugin ignores hash fragments on images
  • Fixed #6180: Projects plugin crashing when adding or removing files

mkdocs-material-9.4.6 (2023-10-14)

  • Updated Danish and Norwegian (Nynorsk) translations
  • Fixed #6169: Blog post metadata layout overflows on small screens

mkdocs-material-9.4.5 (2023-10-10)

  • Fixed sidebar auto-positioning (9.4.2 regression)
  • Fixed #6166: Improve group plugin compatibility with Python < 3.10
  • Fixed #6157: Hiding tags does not work (9.4.3 regression)

mkdocs-material-9.4.4+insiders-4.42.1 (2023-10-05)

  • Fixed spacing of related links in blog posts on small screens

mkdocs-material-9.4.4 (2023-10-05)

  • Added support for overriding text to be copied for code blocks
  • Fixed broken layout in some browsers at breakpoints when using zoom
  • Fixed #6132: Incomplete search highlighting for code blocks in titles

mkdocs-material-9.4.3 (2023-10-02)

  • Added support for instant navigation progress indicator
  • Improved spacing and alignment of tags
  • Moved back-to-top button into separate partial
  • Fixed #6104: Indentation for some code blocks lost in search
  • Fixed #6094: Blog post metadata overlaps with footer on small screens
  • Fixed #6069: Blog plugin crashes for categories with non-ASCII names

Updated templates

  • base.html

mkdocs-material-9.4.2 (2023-09-25)

  • 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

... (truncated)

Upgrade guide

Sourced from mkdocs-material's upgrade guide.

How to upgrade

Upgrade to the latest version with:

pip install --upgrade --force-reinstall mkdocs-material

Show the currently installed version with:

pip show mkdocs-material

Upgrading from 8.x to 9.x

This major release includes a brand new search implementation that is faster and allows for rich previews, advanced tokenization and better highlighting. It was available as part of Insiders for over a year, and now that the funding goal was hit, makes its way into the community edition.

Changes to mkdocs.yml

content.code.copy

The copy-to-clipboard buttons are now opt-in and can be enabled or disabled per block. If you wish to enable them for all code blocks, add the following lines to mkdocs.yml:

theme:
  features:
    - content.code.copy

content.action.*

A "view source" button can be shown next to the "edit this page" button, both of which must now be explicitly enabled. Add the following lines to mkdocs.yml:

theme:
  features:
    - content.action.edit
    - content.action.view

navigation.footer

... (truncated)

Commits
  • 2742a70 Updated Insiders changelog
  • 1990b21 Prepare 9.4.6 release
  • 7fa5ea0 Updated Danish translations
  • 2800e7e Fixed blog post metadata layout on small screens
  • c516ddf Updated dependencies
  • e20cf0b Updated Norwegian (Nynorsk) translations
  • 39e1251 Install extras from local package for development environment setup (#6189)
  • c3683b2 Escaped snippet syntax in code block example (#6183)
  • 81a9437 Updated README
  • fe69add Prepare 9.4.5 release
  • Additional commits viewable in compare view

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 in /docs with 2 updates: [markdown-include](https://github.com/cmacmackin/markdown-include) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `markdown-include` from 0.8.0 to 0.8.1
- [Release notes](https://github.com/cmacmackin/markdown-include/releases)
- [Commits](cmacmackin/markdown-include@v0.8.0...v0.8.1)

Updates `mkdocs-material` from 8.5.11 to 9.4.6
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Upgrade guide](https://github.com/squidfunk/mkdocs-material/blob/master/docs/upgrade.md)
- [Commits](squidfunk/mkdocs-material@8.5.11...9.4.6)

---
updated-dependencies:
- dependency-name: markdown-include
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: docs
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-major
  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 Oct 18, 2023
@wyfo wyfo force-pushed the master branch 2 times, most recently from 0830388 to b153121 Compare October 19, 2023 09:13
@wyfo wyfo merged commit fe09c91 into master Oct 20, 2023
3 checks passed
@wyfo wyfo deleted the dependabot/pip/docs/docs-9956c4e331 branch October 20, 2023 09:30
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.

1 participant