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

chore(deps-dev): bump mkdocs from 1.4.3 to 1.5.2 #215

Merged
merged 1 commit into from
Aug 13, 2023

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 13, 2023

Bumps mkdocs from 1.4.3 to 1.5.2.

Release notes

Sourced from mkdocs's releases.

1.5.2

  • Bugfix (regression in 1.5.0): Restore functionality of --no-livereload. (#3320)

  • Bugfix (regression in 1.5.0): The new page title detection would sometimes be unable to drop anchorlinks - fix that. (#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)

See commit log.

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)

See commit log.

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

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 @​pawamoy @​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:

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.

... (truncated)

Commits
  • 79f17b4 Release 1.5.2 (#3330)
  • 91e37ae Change extra_javascript items to usually be strings again (#3324)
  • 4944c9f Drop obsolete readthedocs config, we switched to gh-pages (#3326)
  • 63052bc Correct detection of dropping anchorlink from page title (#3325)
  • fcb2da3 Restore functionality of --no-livereload (#3320)
  • 2865b0f Release 1.5.1 (#3315)
  • ea549e6 Make it possible to treat ExtraScriptValue as a path
  • 86cde7b Catch ValueErrors thrown when attempting to remove a file twice (#3314)
  • 0d9e341 Release 1.5.0 (#3296)
  • 0f8ab6b Fix livereload shutdown sequence - crash on Windows
  • 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 show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Aug 13, 2023
@codecov
Copy link

codecov bot commented Aug 13, 2023

Codecov Report

Merging #215 (a9befd4) into main (7400da3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #215   +/-   ##
=======================================
  Coverage   98.36%   98.36%           
=======================================
  Files          19       19           
  Lines         736      736           
  Branches       87       87           
=======================================
  Hits          724      724           
  Misses         10       10           
  Partials        2        2           

Bumps [mkdocs](https://github.com/mkdocs/mkdocs) from 1.4.3 to 1.5.2.
- [Release notes](https://github.com/mkdocs/mkdocs/releases)
- [Commits](mkdocs/mkdocs@1.4.3...1.5.2)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/pip/mkdocs-1.5.2 branch from a4fda27 to a9befd4 Compare August 13, 2023 15:28
@mcous mcous merged commit 28a7a07 into main Aug 13, 2023
19 checks passed
@mcous mcous deleted the dependabot/pip/mkdocs-1.5.2 branch August 13, 2023 15:55
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