From 9da914a92cd813fa31283dafc3e8cda15c715578 Mon Sep 17 00:00:00 2001 From: javierzazo Date: Mon, 17 Feb 2025 16:00:44 +0000 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=92=A9=20poop:=20breaking=20change?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index b5ca751..609086c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,7 +25,7 @@ docs = [ "mkdocs-material", "mkdocs-video", "mkdocstrings", - "mkdocstrings-python==1.13", + "mkdocstrings-python==1.16", "pymdown-extensions", ] From 2614832facff988950c04a9020501f683ea3f530 Mon Sep 17 00:00:00 2001 From: javierzazo Date: Mon, 17 Feb 2025 16:39:38 +0000 Subject: [PATCH 2/2] fix: wrong indentation in mkdocs.yml --- mkdocs.yml | 4 ++-- pyproject.toml | 2 +- template/pyproject.toml.jinja | 2 +- .../{% if documentation %}mkdocs.yml{% endif %}.jinja | 4 ++-- uv.lock | 10 +++++----- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 02b60a1..9c4d053 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,10 +67,10 @@ plugins: show_source: true group_by_category: false show_category_heading: true + merge_init_into_class: true + separate_signature: true docstring_options: ignore_init_summary: false - merge_init_into_class: true - separate_signature: true - awesome-pages - git-revision-date-localized: enable_creation_date: true diff --git a/pyproject.toml b/pyproject.toml index 609086c..5b94cc6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,7 +25,7 @@ docs = [ "mkdocs-material", "mkdocs-video", "mkdocstrings", - "mkdocstrings-python==1.16", + "mkdocstrings-python", "pymdown-extensions", ] diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja index 6e198d3..c29a3ae 100644 --- a/template/pyproject.toml.jinja +++ b/template/pyproject.toml.jinja @@ -18,7 +18,7 @@ docs = [ "mkdocs-material", "mkdocs-video", "mkdocstrings", - "mkdocstrings-python==1.13", + "mkdocstrings-python", "pymdown-extensions", ] {% endif %} diff --git a/template/{% if documentation %}mkdocs.yml{% endif %}.jinja b/template/{% if documentation %}mkdocs.yml{% endif %}.jinja index 60a99f4..1a0980b 100644 --- a/template/{% if documentation %}mkdocs.yml{% endif %}.jinja +++ b/template/{% if documentation %}mkdocs.yml{% endif %}.jinja @@ -65,10 +65,10 @@ plugins: show_source: true group_by_category: false show_category_heading: true + merge_init_into_class: true + separate_signature: true docstring_options: ignore_init_summary: false - merge_init_into_class: true - separate_signature: true - awesome-pages - mkdocs-video: is_video: true diff --git a/uv.lock b/uv.lock index 72cef78..4436475 100644 --- a/uv.lock +++ b/uv.lock @@ -158,7 +158,7 @@ wheels = [ [[package]] name = "cookie-doh" -version = "0.0.19" +version = "0.0.20" source = { editable = "." } [package.dev-dependencies] @@ -201,7 +201,7 @@ docs = [ { name = "mkdocs-material" }, { name = "mkdocs-video" }, { name = "mkdocstrings" }, - { name = "mkdocstrings-python", specifier = "==1.13" }, + { name = "mkdocstrings-python" }, { name = "pymdown-extensions" }, ] @@ -698,16 +698,16 @@ wheels = [ [[package]] name = "mkdocstrings-python" -version = "1.13.0" +version = "1.16.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "griffe" }, { name = "mkdocs-autorefs" }, { name = "mkdocstrings" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/ab/ae/32703e35d74040051c672400fd9f5f2b48a6ea094f5071dd8a0e3be35322/mkdocstrings_python-1.13.0.tar.gz", hash = "sha256:2dbd5757e8375b9720e81db16f52f1856bf59905428fd7ef88005d1370e2f64c", size = 185697 } +sdist = { url = "https://files.pythonhosted.org/packages/41/d9/7e4900326cd3c27aed05379ff4c4b5f10435845ea26b1f764353405f3b75/mkdocstrings_python-1.16.0.tar.gz", hash = "sha256:546d53c7d559941abc726b2f78a41c0183480a95ba0a87ccc63b9b08740126f9", size = 423102 } wheels = [ - { url = "https://files.pythonhosted.org/packages/51/23/d02d86553327296c3bf369d444194ea83410cce8f0e690565264f37f3261/mkdocstrings_python-1.13.0-py3-none-any.whl", hash = "sha256:b88bbb207bab4086434743849f8e796788b373bd32e7bfefbf8560ac45d88f97", size = 112254 }, + { url = "https://files.pythonhosted.org/packages/66/54/8a2eeddc77a68eae88bd3d4a04638797e172bd462344a9a883aacee18aac/mkdocstrings_python-1.16.0-py3-none-any.whl", hash = "sha256:80ecbcca67fe29eb5a853ab7be0457231f6eefb5d079bcdf7dbae16962fc3f51", size = 449114 }, ] [[package]]