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

⬆️ Update mkdocstrings requirement from ^0.14.0 to ^0.15.0 #110

Merged
merged 1 commit into from
Mar 3, 2021

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 1, 2021

⚠️ Dependabot is rebasing this PR ⚠️

If you make any changes to it yourself then they will take precedence over the rebase.


Updates the requirements on mkdocstrings to permit the latest version.

Changelog

Sourced from mkdocstrings's changelog.

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

0.14.0 - 2021-01-06

Compare with 0.13.6

Special thanks to Oleh @​oprypin Prypin who did an amazing job (this is a euphemism) at improving mkdocstrings, fixing hard-to-fix bugs with clever solutions, implementing great new features and refactoring the code for better performance and readability! Thanks Oleh!

Bug Fixes

... (truncated)

Commits
  • 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
  • c29ba6b style: Normalize and enforce docstring style
  • f5ff1d7 Merge pull request #246 from mkdocstrings/remove-circular-import
  • 5d7ac31 Merge pull request #244 from oprypin/doccss
  • 83c87d0 refactor: Remove circular import
  • cb2a802 Merge pull request #245 from oprypin/hlcls
  • c7d80e6 fix: Propagate the CSS class to inline highlighting as well
  • ffcca02 Docs: document xrefs to a sub-heading & CSS classes for highlighting
  • 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 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 Mar 1, 2021
@github-actions
Copy link

github-actions bot commented Mar 1, 2021

🚀 Deployed on https://docs-preview-110--odmantic.netlify.app

@art049 art049 merged commit 15f367e into master Mar 3, 2021
@art049 art049 deleted the dependabot/pip/mkdocstrings-tw-0.15.0 branch March 3, 2021 15:06
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.

1 participant