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 dependency mkdocstrings to ^0.15.0 #18

Merged
merged 1 commit into from Jun 15, 2021

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Jun 15, 2021

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mkdocstrings ^0.13.6 -> ^0.15.0 age adoption passing confidence

Release Notes

mkdocstrings/mkdocstrings

v0.15.2

Compare Source

Compare with 0.15.1

Packaging
  • MkDocs default schema needs to be obtained differently now (b3e122b by Oleh Prypin). PR #​273
  • Compatibility with MkDocs 1.2: livereload isn't guaranteed now (36e8024 by Oleh Prypin). PR #​294

v0.15.1

Compare Source

Compare with 0.15.0

Bug Fixes
  • Prevent error during parallel installations (fac2c71 by Timothée Mazzucotelli).
Packaging
  • Support the upcoming major Jinja and MarkupSafe releases (bb4f9de by Oleh Prypin). PR #​283
  • Accept a higher version of mkdocs-autorefs (c8de08e by Oleh Prypin). PR #​282

v0.15.0

Compare Source

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
  • Nicer-looking error outputs - no tracebacks from mkdocstrings (6baf720 by Oleh Prypin). PR #​230
  • Let handlers add CSS to the pages, do so for Python handler (05c7a3f by Oleh Prypin). Issue #​189, PR #​218
  • Allow linking to an object heading not only by its canonical identifier, but also by its possible aliases (4789950 by Oleh Prypin). PR #​217
Bug Fixes
Code Refactoring
  • Use the autorefs plugin from its new external location (e2d74ef by Oleh Prypin). PR #​235
  • Split out Markdown extensions from handlers to handlers.rendering (7533852 by Oleh Prypin). PR #​233
  • Theme-agnostic code highlighting, respecting configs (f9ea009 by Oleh Prypin). PR #​202
  • Split out autorefs plugin, make it optional (fc67656 by Oleh Prypin). PR #​220
  • Remove the extra wrapper div from the final doc (7fe438c by Oleh Prypin). PR #​209
  • Don't re-parse the whole subdoc, expose only headings (15f84f9 by Oleh Prypin). PR #​209
  • Actually exclude hidden headings from the doc (0fdb082 by Oleh Prypin). PR #​209

v0.14.0

Compare Source

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
Code Refactoring
  • BlockProcessor already receives strings, use them as such (bcf7da9 by Oleh Prypin).
  • Remove some unused code (8504084 by Oleh Prypin). PR #​206
  • Improve XML parsing error handling (ad86410 by Timothée Mazzucotelli).
  • Explicitly use MarkupSafe (6b9ebe7 by Oleh Prypin).
  • Split out the handler cache, expose it through the plugin (6453026 by Oleh Prypin). Issue #​179, PR #​191
  • Use ChainMap instead of copying dicts (c634d2c by Oleh Prypin). PR #​171
  • Rename logging to loggers to avoid confusion (7a119cc by Timothée Mazzucotelli).
  • Simplify logging (409f93e by Timothée Mazzucotelli).
Features
  • Allow specifying heading_level as a Markdown heading (10efc28 by Oleh Prypin). PR #​170
  • Allow any characters in identifiers (7ede68a by Oleh Prypin). PR #​174
  • Allow namespace packages for handlers (39b0465 by Timothée Mazzucotelli).
  • Add template debugging/logging (33b32c1 by Timothée Mazzucotelli).
  • Add initial support for the ReadTheDocs theme (1028115 by Timothée Mazzucotelli). Issue #​107, PR #​159
  • Add option to show type annotations in signatures (f94ce9b by Timothée Mazzucotelli). Issue #​106
Packaging
  • Accept verions of pytkdocs up to 0.10.x (see changelog).
Performance Improvements

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box.

This PR has been generated by WhiteSource Renovate. View repository job log here.

@codecov
Copy link

codecov bot commented Jun 15, 2021

Codecov Report

Merging #18 (b751d7e) into main (d9a813c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #18   +/-   ##
=======================================
  Coverage   94.56%   94.56%           
=======================================
  Files           8        8           
  Lines         368      368           
=======================================
  Hits          348      348           
  Misses         20       20           

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 d9a813c...b751d7e. Read the comment docs.

@mochipon mochipon merged commit b76c782 into main Jun 15, 2021
@mochipon mochipon deleted the renovate/mkdocstrings-0.x branch June 15, 2021 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants