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 mkdocstrings from 0.13.6 to 0.15.2 #325

Merged
merged 2 commits into from Jul 20, 2021

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 15, 2021

Bumps mkdocstrings from 0.13.6 to 0.15.2.

Changelog

Sourced from mkdocstrings's changelog.

0.15.2 - 2021-06-09

Compare with 0.15.1

Packaging

0.15.1 - 2021-05-16

Compare with 0.15.0

Bug Fixes

  • Prevent error during parallel installations (fac2c71 by Timothée Mazzucotelli).

Packaging

0.15.0 - 2021-02-28

Compare with 0.14.0

Breaking Changes

The following items are possible breaking changes:

  • Cross-linking to arbitrary headings now requires to opt-in to the autorefs plugin, which is installed as a dependency of mkdocstrings. See Cross-references to any Markdown heading.
  • mkdocstrings now respects your configured code highlighting method, so if you are using the CodeHilite extension, the .highlight CSS class in the rendered HTML will become .codehilite. So make sure to adapt your extra CSS accordingly. Or just switch to using pymdownx.highlight, it's better supported by mkdocstrings anyway. See Syntax highlighting.
  • Most of the CSS rules that mkdocstrings used to recommend for manual addition, now become mandatory (auto-injected into the site). This shouldn't break any of your styles, but you are welcome to remove the now-redundant lines that you had copied into extra_css, similarly to this diff.

Features

Bug Fixes

Code Refactoring

... (truncated)

Commits
  • 2b0f809 chore: Prepare release 0.15.2
  • 36e8024 refactor: Compatibility with MkDocs 1.2: livereload isn't guaranteed now
  • b3e122b chore: MkDocs default schema needs to be obtained differently now
  • 07fb484 chore: Prepare release 0.15.1
  • fac2c71 fix: Prevent error during parallel installations
  • bb4f9de build: Support the upcoming major Jinja and MarkupSafe releases
  • c8de08e chore: Also accept a higher version of mkdocs-autorefs
  • 65732a2 chore: Prepare release 0.15.0
  • fc9fe34 pkg: Accept pytkdocs v0.11
  • d5a1e39 ci: Don't fail when checking docs on Python 3.6
  • 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)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Jul 15, 2021
@cloudflare-pages
Copy link

cloudflare-pages bot commented Jul 15, 2021

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 76d7eca
Status: ✅  Deploy successful!
Preview URL: https://235b3ae0.opensafely-docs.pages.dev

View logs

@dependabot dependabot bot force-pushed the dependabot/pip/mkdocstrings-0.15.2 branch 2 times, most recently from 0b2e0ec to 9d3534d Compare July 15, 2021 14:55
@madwort
Copy link
Contributor

madwort commented Jul 15, 2021

seems that a template file in mkdocstring may need to be updated, will file a ticket there

Bumps [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) from 0.13.6 to 0.15.2.
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/master/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.13.6...0.15.2)

---
updated-dependencies:
- dependency-name: mkdocstrings
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/mkdocstrings-0.15.2 branch from 9d3534d to 2170f98 Compare July 20, 2021 09:31
@StevenMaude
Copy link
Contributor

As mentioned in the related mkdocs upgrade PR, this fails due to:

  File "templates/python/material/parameters.html", line 14, in top-level template code
    <td>{{ parameter.description|convert_markdown }}</td>
TypeError: do_convert_markdown() missing 1 required positional argument: 'heading_level'

This really confused me because there's no such line in mkdocstrings source that I could find.

From looking in mkdocs.yml at the mkdocstrings configuration, I noticed that templates/python/material/parameters.html is actually a file we're including as an override. (The not-so-subtle clue is in the directory name: overrides). So the fix is to update that template file to pass heading_level in the do_convert_markdown() call.

To match the current version of mkdocstrings.

We previously introduced this override in #67 to remove the "Type"
column from the templated output. However, the underlying API has
changed. Therefore, this commit updates our override to match the
current version of the template.
@StevenMaude StevenMaude force-pushed the dependabot/pip/mkdocstrings-0.15.2 branch from 8a80e4b to 76d7eca Compare July 20, 2021 10:42
@StevenMaude StevenMaude merged commit 26bd77f into main Jul 20, 2021
@StevenMaude StevenMaude deleted the dependabot/pip/mkdocstrings-0.15.2 branch July 20, 2021 10:52
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants