Skip to content
This repository has been archived by the owner on Nov 23, 2024. It is now read-only.

Commit

Permalink
build(deps-dev): Bump mkdocstrings-python from 1.2.1 to 1.6.0 (#163)
Browse files Browse the repository at this point in the history
Bumps [mkdocstrings-python](https://github.com/mkdocstrings/python) from
1.2.1 to 1.6.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/mkdocstrings/python/releases">mkdocstrings-python's
releases</a>.</em></p>
<blockquote>
<h2>1.6.0</h2>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.6.0">1.6.0</a>
- 2023-08-27</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.5.2...1.6.0">Compare
with 1.5.2</a><!-- raw HTML omitted --></p>
<h3>Features</h3>
<ul>
<li>Add <code>doc-signature</code> CSS class to separate signature code
blocks (<a
href="https://github.com/mkdocstrings/python/commit/b6c648f554f2e0dce609afc2a2c1a3b27a4fbeba">b6c648f</a>
by Timothée Mazzucotelli).</li>
</ul>
<h3>Code Refactoring</h3>
<ul>
<li>Add a <code>format_attribute</code> filter, preparing for cross-refs
in attribute signatures (<a
href="https://github.com/mkdocstrings/python/commit/8f0ade249638ee2f2d446f083c70b6c30799875a">8f0ade2</a>
by Timothée Mazzucotelli).</li>
</ul>
<h2>1.5.2</h2>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.5.2">1.5.2</a>
- 2023-08-25</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.5.1...1.5.2">Compare
with 1.5.1</a><!-- raw HTML omitted --></p>
<h3>Bug Fixes</h3>
<ul>
<li>Regression in children template: fix condition for when members are
specified (<a
href="https://github.com/mkdocstrings/python/commit/beeebffa36288d1f71d122f78ecd9064b41a75d0">beeebff</a>
by Timothée Mazzucotelli). [Issue <a
href="https://redirect.github.com/mkdocstrings/python/issues/100">#100</a>](<a
href="https://redirect.github.com/mkdocstrings/python/issues/100">mkdocstrings/python#100</a>)</li>
<li>Prevent whitespace removal before highlight filter (<a
href="https://github.com/mkdocstrings/python/commit/c6f36c0c9e5141800f8c5c988c9b67720fccccb8">c6f36c0</a>
by Timothée Mazzucotelli).</li>
</ul>
<h3>Code Refactoring</h3>
<ul>
<li>Never show full object path in ToC entry (<a
href="https://github.com/mkdocstrings/python/commit/9aa758bcc42dfcf7c416d87b8f7cd407b7fdf148">9aa758b</a>
by Timothée Mazzucotelli).</li>
<li>Sync templates with insiders, remove useless lines (<a
href="https://github.com/mkdocstrings/python/commit/38b317f4fc74b583a4788721a5559c51a5a47d86">38b317f</a>
by Timothée Mazzucotelli).</li>
</ul>
<h2>1.5.1</h2>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.5.1">1.5.1</a>
- 2023-08-24</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.5.0...1.5.1">Compare
with 1.5.0</a><!-- raw HTML omitted --></p>
<h3>Code Refactoring</h3>
<ul>
<li>Never show full path in separate signature since it would appear in
the heading already (<a
href="https://github.com/mkdocstrings/python/commit/9e0204930cf4dc973ba8eb41c471fc0132e1631f">9e02049</a>
by Timothée Mazzucotelli).</li>
<li>Improve guessing whether an object is public (<a
href="https://github.com/mkdocstrings/python/commit/35eb81162582d794f170cd7e8c68f10ecfd8ff9d">35eb811</a>
by Timothée Mazzucotelli).</li>
<li>Always sort modules alphabetically as source order wouldn't make
sense (<a
href="https://github.com/mkdocstrings/python/commit/70c81cebb62366cbfc6124bc84d1563db176afb6">70c81ce</a>
by Timothée Mazzucotelli).</li>
<li>Return anchors as a tuple, not a set, to preserve order (<a
href="https://github.com/mkdocstrings/python/commit/736a2b5e729d25bb184db8d42f2ad01025a5bc58">736a2b5</a>
by Timothée Mazzucotelli). <a
href="https://redirect.github.com/mkdocstrings/crystal/pull/6">Related-to
#mkdocstrings/crystal#6</a></li>
</ul>
<h2>1.5.0</h2>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.5.0">1.5.0</a>
- 2023-08-20</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.4.0...1.5.0">Compare
with 1.4.0</a><!-- raw HTML omitted --></p>
<h3>Features</h3>
<ul>
<li>Add support for new Griffe docstring sections: modules, classes, and
functions (methods) (<a
href="https://github.com/mkdocstrings/python/commit/d5337afdf68fc492b34f749aa69d1da33b49f9c2">d5337af</a>
by Timothée Mazzucotelli).</li>
</ul>
<h2>1.4.0</h2>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md">mkdocstrings-python's
changelog</a>.</em></p>
<blockquote>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.6.0">1.6.0</a>
- 2023-08-27</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.5.2...1.6.0">Compare
with 1.5.2</a><!-- raw HTML omitted --></p>
<h3>Features</h3>
<ul>
<li>Add <code>doc-signature</code> CSS class to separate signature code
blocks (<a
href="https://github.com/mkdocstrings/python/commit/b6c648f554f2e0dce609afc2a2c1a3b27a4fbeba">b6c648f</a>
by Timothée Mazzucotelli).</li>
</ul>
<h3>Code Refactoring</h3>
<ul>
<li>Add a <code>format_attribute</code> filter, preparing for cross-refs
in attribute signatures (<a
href="https://github.com/mkdocstrings/python/commit/8f0ade249638ee2f2d446f083c70b6c30799875a">8f0ade2</a>
by Timothée Mazzucotelli).</li>
</ul>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.5.2">1.5.2</a>
- 2023-08-25</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.5.1...1.5.2">Compare
with 1.5.1</a><!-- raw HTML omitted --></p>
<h3>Bug Fixes</h3>
<ul>
<li>Regression in children template: fix condition for when members are
specified (<a
href="https://github.com/mkdocstrings/python/commit/beeebffa36288d1f71d122f78ecd9064b41a75d0">beeebff</a>
by Timothée Mazzucotelli). [Issue <a
href="https://redirect.github.com/mkdocstrings/python/issues/100">#100</a>](<a
href="https://redirect.github.com/mkdocstrings/python/issues/100">mkdocstrings/python#100</a>)</li>
<li>Prevent whitespace removal before highlight filter (<a
href="https://github.com/mkdocstrings/python/commit/c6f36c0c9e5141800f8c5c988c9b67720fccccb8">c6f36c0</a>
by Timothée Mazzucotelli).</li>
</ul>
<h3>Code Refactoring</h3>
<ul>
<li>Never show full object path in ToC entry (<a
href="https://github.com/mkdocstrings/python/commit/9aa758bcc42dfcf7c416d87b8f7cd407b7fdf148">9aa758b</a>
by Timothée Mazzucotelli).</li>
<li>Sync templates with insiders, remove useless lines (<a
href="https://github.com/mkdocstrings/python/commit/38b317f4fc74b583a4788721a5559c51a5a47d86">38b317f</a>
by Timothée Mazzucotelli).</li>
</ul>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.5.1">1.5.1</a>
- 2023-08-24</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.5.0...1.5.1">Compare
with 1.5.0</a><!-- raw HTML omitted --></p>
<h3>Code Refactoring</h3>
<ul>
<li>Never show full path in separate signature since it would appear in
the heading already (<a
href="https://github.com/mkdocstrings/python/commit/9e0204930cf4dc973ba8eb41c471fc0132e1631f">9e02049</a>
by Timothée Mazzucotelli).</li>
<li>Improve guessing whether an object is public (<a
href="https://github.com/mkdocstrings/python/commit/35eb81162582d794f170cd7e8c68f10ecfd8ff9d">35eb811</a>
by Timothée Mazzucotelli).</li>
<li>Always sort modules alphabetically as source order wouldn't make
sense (<a
href="https://github.com/mkdocstrings/python/commit/70c81cebb62366cbfc6124bc84d1563db176afb6">70c81ce</a>
by Timothée Mazzucotelli).</li>
<li>Return anchors as a tuple, not a set, to preserve order (<a
href="https://github.com/mkdocstrings/python/commit/736a2b5e729d25bb184db8d42f2ad01025a5bc58">736a2b5</a>
by Timothée Mazzucotelli). <a
href="https://redirect.github.com/mkdocstrings/crystal/pull/6">Related-to
#mkdocstrings/crystal#6</a></li>
</ul>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.5.0">1.5.0</a>
- 2023-08-20</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.4.0...1.5.0">Compare
with 1.4.0</a><!-- raw HTML omitted --></p>
<h3>Features</h3>
<ul>
<li>Add support for new Griffe docstring sections: modules, classes, and
functions (methods) (<a
href="https://github.com/mkdocstrings/python/commit/d5337afdf68fc492b34f749aa69d1da33b49f9c2">d5337af</a>
by Timothée Mazzucotelli).</li>
</ul>
<h2><a
href="https://github.com/mkdocstrings/python/releases/tag/1.4.0">1.4.0</a>
- 2023-08-18</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/python/compare/1.3.0...1.4.0">Compare
with 1.3.0</a><!-- raw HTML omitted --></p>
<h3>Features</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/mkdocstrings/python/commit/cc3a489b48e0c7f1d158882bbbfc40c86a5d678f"><code>cc3a489</code></a>
chore: Prepare release 1.6.0</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/b6c648f554f2e0dce609afc2a2c1a3b27a4fbeba"><code>b6c648f</code></a>
feat: Add <code>doc-signature</code> CSS class to separate signature
code blocks</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/8f0ade249638ee2f2d446f083c70b6c30799875a"><code>8f0ade2</code></a>
refactor: Add a <code>format_attribute</code> filter, preparing for
cross-refs in attrib...</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/d56ebcc2b92e3b1513300977600c197edef31989"><code>d56ebcc</code></a>
chore: Prepare release 1.5.2</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/beeebffa36288d1f71d122f78ecd9064b41a75d0"><code>beeebff</code></a>
fix: Regression in children template: fix condition for when members are
spec...</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/9aa758bcc42dfcf7c416d87b8f7cd407b7fdf148"><code>9aa758b</code></a>
refactor: Never show full object path in ToC entry</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/38b317f4fc74b583a4788721a5559c51a5a47d86"><code>38b317f</code></a>
refactor: Sync templates with insiders, remove useless lines</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/c6f36c0c9e5141800f8c5c988c9b67720fccccb8"><code>c6f36c0</code></a>
fix: Prevent whitespace removal before highlight filter</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/d3eee03892547d2187d3084b99472de9c7337328"><code>d3eee03</code></a>
chore: Prepare release 1.5.1</li>
<li><a
href="https://github.com/mkdocstrings/python/commit/9e0204930cf4dc973ba8eb41c471fc0132e1631f"><code>9e02049</code></a>
refactor: Never show full path in separate signature since it would
appear in...</li>
<li>Additional commits viewable in <a
href="https://github.com/mkdocstrings/python/compare/1.2.1...1.6.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mkdocstrings-python&package-manager=pip&previous-version=1.2.1&new-version=1.6.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

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-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

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)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
dependabot[bot] authored Sep 1, 2023
1 parent 91c698f commit c3a11a6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ pytest-cov = "^4.0.0"
jupyter = "^1.0.0"
mkdocs = "^1.4.2"
mkdocstrings = ">=0.20,<0.23"
mkdocstrings-python = ">=0.8.3,<1.3.0"
mkdocstrings-python = ">=0.8.3,<1.7.0"
mkdocs-autorefs = "^0.4.1"
mkdocs-exclude = "^1.0.2"
mkdocs-gen-files = ">=0.4,<0.6"
Expand Down

0 comments on commit c3a11a6

Please sign in to comment.