From bc25b6a00cb1515f0dc8c433ae595092fcddfba8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Sat, 27 Apr 2024 18:26:09 +0200 Subject: [PATCH 1/4] docs: Remove requirements link in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 44158d4a..10b3b8ff 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Come have a chat or ask questions on our [Gitter channel](https://gitter.im/mkdo --- -**[Features](#features)** - **[Requirements](#requirements)** - **[Installation](#installation)** - **[Quick usage](#quick-usage)** +**[Features](#features)** - **[Installation](#installation)** - **[Quick usage](#quick-usage)** ![mkdocstrings_gif1](https://user-images.githubusercontent.com/3999221/77157604-fb807480-6aa1-11ea-99e0-d092371d4de0.gif) From a86ca7d24a57b1217ee9d21c96d133ef31dcbd62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Sat, 27 Apr 2024 18:26:22 +0200 Subject: [PATCH 2/4] docs: Customize parameters color in ToC --- docs/css/mkdocstrings.css | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/css/mkdocstrings.css b/docs/css/mkdocstrings.css index 3960e49e..9e17377f 100644 --- a/docs/css/mkdocstrings.css +++ b/docs/css/mkdocstrings.css @@ -29,4 +29,14 @@ a.autorefs-external:hover::after { /* Avoid breaking parameters name, etc. in table cells. */ td code { word-break: normal !important; -} \ No newline at end of file +} + +[data-md-color-scheme="default"] { + --doc-symbol-parameter-fg-color: #d3a81b; + --doc-symbol-parameter-bg-color: #d3a81b1a; +} + +[data-md-color-scheme="slate"] { + --doc-symbol-parameter-fg-color: #dfbe50; + --doc-symbol-parameter-bg-color: #dfbe501a; +} From cb86e08bbc5e8057393aa1cd7ca29bc2b40ab5eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Sun, 5 May 2024 15:44:43 +0200 Subject: [PATCH 3/4] fix: Always descend into sub-headings when re-applying their label Issue-mkdocstrings/python-158: https://github.com/mkdocstrings/python/issues/158 --- src/mkdocstrings/extension.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/mkdocstrings/extension.py b/src/mkdocstrings/extension.py index 23e90cff..9ecffebc 100644 --- a/src/mkdocstrings/extension.py +++ b/src/mkdocstrings/extension.py @@ -261,7 +261,7 @@ def _override_toc_labels(self, tokens: list[dict[str, Any]]) -> None: for token in tokens: if (label := token.get("data-toc-label")) and token["name"] != label: token["name"] = label - self._override_toc_labels(token["children"]) + self._override_toc_labels(token["children"]) class MkdocstringsExtension(Extension): From e135869681dc712a3721a7753c9825b8c040bb83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Sun, 5 May 2024 16:08:59 +0200 Subject: [PATCH 4/4] chore: Prepare release 0.25.1 --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7066ff44..105df260 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +## [0.25.1](https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.25.1) - 2024-05-05 + +[Compare with 0.25.0](https://github.com/mkdocstrings/mkdocstrings/compare/0.25.0...0.25.1) + +### Bug Fixes + +- Always descend into sub-headings when re-applying their label ([cb86e08](https://github.com/mkdocstrings/mkdocstrings/commit/cb86e08bbc5e8057393aa1cd7ca29bc2b40ab5eb) by Timothée Mazzucotelli). [Issue-mkdocstrings/python-158](https://github.com/mkdocstrings/python/issues/158) + ## [0.25.0](https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.25.0) - 2024-04-27 [Compare with 0.24.3](https://github.com/mkdocstrings/mkdocstrings/compare/0.24.3...0.25.0)