Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 30, 2021

Bumps mkdocs-material from 7.2.6 to 8.0.2.

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-8.0.2

  • Fixed #3275: Code annotations always disappear on click

mkdocs-material-8.0.1

  • Improved rendering of code annotation markers
  • Fixed #3265: Wrong margin on nested admonitions
  • Fixed wrong box-sizing for code annotations in details

mkdocs-material-8.0.0

  • Added support for code annotations
  • Added support for anchor tracking
  • Added support for version warning
  • Added copyright partial for easier override
  • Removed deprecated content tabs legacy implementation
  • Removed deprecated seealso admonition type
  • Removed deprecated site_keywords setting (unsupported by MkDocs)
  • Removed deprecated prebuilt search index support
  • Removed deprecated web app manifest – use customization
  • Removed extracopyright variable – use new copyright partial
  • Removed Disqus integation – use customization
  • Switched to :is() selectors for simple selector lists
  • Switched autoprefixer from last 4 years to last 2 years
  • Improved CSS overall to match modern standards
  • Improved CSS variable semantics for fonts
  • Improved extensibility by restructuring partials
  • Improved handling of details when printing
  • Improved keyboard navigation for footnotes
  • Fixed #3214: Search highlighting breaks site when empty

Please see the upgrade guide

mkdocs-material-8.0.0b2

  • Switched to :is() selector for simple selector lists (main.css drops from 18kb to 16kb gzipped)
  • Switched autoprefixer from last 4 years to last 2 years
  • Fixed code annotations not scrolling on overflowing code blocks
  • Fixed code annotations rendered too narrow on mobile
  • Fixed code annotations overflowing on mobile
  • Fixed code annotations not mounted due to empty p tags
  • Fixed code after code annotations not aligning with grid
  • Fixed #3214: search highlighting breaks site when empty

mkdocs-material-8.0.0b1

Note: this is a beta release with several breaking changes – see #3219

  • Added support for code annotations
  • Added support for anchor tracking
  • Added support for version warning
  • Removed deprecated legacy Tabbed implementation
  • Removed deprecated seealso admonition type
  • Removed deprecated site_keywords setting (unsupported by MkDocs)

... (truncated)

Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-8.0.2 (2021-11-30)

  • Fixed #3275: Code annotations always disappear on click

mkdocs-material-8.0.1 (2021-11-28)

  • Improved rendering of code annotation markers
  • Fixed #3265: Wrong margin on nested admonitions
  • Fixed wrong box-sizing for code annotations in details

mkdocs-material-8.0.0 (2021-11-28)

  • Added support for code annotations
  • Added support for anchor tracking
  • Added support for version warning
  • Added copyright partial for easier override
  • Removed deprecated content tabs legacy implementation
  • Removed deprecated seealso admonition type
  • Removed deprecated site_keywords setting (unsupported by MkDocs)
  • Removed deprecated prebuilt search index support
  • Removed deprecated web app manifest – use customization
  • Removed extracopyright variable – use new copyright partial
  • Removed Disqus integation – use customization
  • Switched to :is() selectors for simple selector lists
  • Switched autoprefixer from last 4 years to last 2 years
  • Improved CSS overall to match modern standards
  • Improved CSS variable semantics for fonts
  • Improved extensibility by restructuring partials
  • Improved handling of details when printing
  • Improved keyboard navigation for footnotes
  • Fixed #3214: Search highlighting breaks site when empty

mkdocs-material-7.3.6+insiders-3.2.3 (2021-11-20)

  • Updated Swedish and French translations
  • Removed support for .mermaid-experimental class (now .mermaid)
  • Fixed #3202: Cookie consent not dismissable on file:// locations
  • Fixed #3216: Cookie consent not dismissed when invoked via anchor
  • Fixed #3232: Mermaid.js sometimes runs twice (race condition)

mkdocs-material-7.3.6+insiders-3.2.2 (2021-11-06)

  • Fixed always last feedback rating being sent
  • Fixed #3145: Code annotations eat whole comment lines
  • Fixed #3170: Feedback widget doesn't send data to GA4

mkdocs-material-7.3.6+insiders-3.2.1 (2021-11-04)

  • Added support for custom Mermaid.js version via additional JavaScript
  • Fixed some configuration edge cases for tags plugin (3.1.5 regression)

... (truncated)

Upgrade guide

Sourced from mkdocs-material's upgrade guide.


template: overrides/main.html

How to upgrade

Upgrade to the latest version with:

pip install --upgrade mkdocs-material

Show the currently installed version with:

pip show mkdocs-material

Upgrading from 7.x to 8.x

What's new?

  • Added support for code annotations
  • Added support for anchor tracking
  • Added support for version warning
  • Added copyright partial for easier override
  • Removed deprecated content tabs legacy implementation
  • Removed deprecated seealso admonition type
  • Removed deprecated site_keywords setting (unsupported by MkDocs)
  • Removed deprecated prebuilt search index support
  • Removed deprecated web app manifest – use customization
  • Removed extracopyright variable – use new copyright partial
  • Removed Disqus integation – use customization
  • Switched to :is() selectors for simple selector lists
  • Switched autoprefixer from last 4 years to last 2 years
  • Improved CSS overall to match modern standards
  • Improved CSS variable semantics for fonts
  • Improved extensibility by restructuring partials
  • Improved handling of details when printing
  • Improved keyboard navigation for footnotes
  • Fixed #3214: Search highlighting breaks site when empty

Changes to mkdocs.yml

pymdownx.tabbed

Support for the legacy style of the [Tabbed] extension was dropped in favor of the new, alternate implementation which has [better behavior on mobile viewports]:

... (truncated)

Commits
  • c08450f Prepare 8.0.2 release
  • 5fb9569 Merge branch 'master' of github.com:squidfunk/mkdocs-material
  • 194a08e Fixed code annotations always closing on click
  • dcb9956 Added python >=3.6 requirement (#3270)
  • 911a0a8 Documentation
  • bfb14d8 Prepare 8.0.1 release
  • 0dd26b9 Fixed wrong box-sizing on nested admonitions
  • 8fa834f Fixed specificity issue with admonitions in lists
  • 674df04 Improved rendering of code annotation markers
  • 334b42e Updated Insiders changelog
  • Additional commits viewable in compare view

Dependabot compatibility score

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 ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 7.2.6 to 8.0.2.
- [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@7.2.6...8.0.2)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Nov 30, 2021
Bumps [mkdocs](https://github.com/mkdocs/mkdocs) from 1.2.2 to 1.2.3.
- [Release notes](https://github.com/mkdocs/mkdocs/releases)
- [Commits](mkdocs/mkdocs@1.2.2...1.2.3)

---
updated-dependencies:
- dependency-name: mkdocs
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Yasser Tahiri <[email protected]>
@pull-request-quantifier-deprecated

This PR has 4 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +2 -2
Percentile : 1.6%

Total files changed: 1

Change summary by file extension:
.txt : +2 -2

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@codecov
Copy link

codecov bot commented Nov 30, 2021

Codecov Report

Merging #9 (18ad0e6) into main (f087b3f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              main        #9   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines           85        85           
  Branches         8         8           
=========================================
  Hits            85        85           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f087b3f...18ad0e6. Read the comment docs.

@yezz123 yezz123 merged commit ab2990c into main Nov 30, 2021
@yezz123 yezz123 deleted the dependabot/pip/mkdocs-material-8.0.2 branch November 30, 2021 15:41
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 Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants